Zengtudor
/
Nuxt
mirror of https://github.com/nuxt/nuxt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: format improvements on get-started

This commit is contained in:
Pooya Parsa 2021-06-09 00:14:22 +02:00
parent d6da38a1fe
commit 4fab80ee23
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/content/1.get-started/1.installation.md
View File

@ -21,7 +21,7 @@ Recommended setup is:
From visual studio code, open an [integrated terminal](https://code.visualstudio.com/docs/editor/integrated-terminal) and use the following command to create a new starter project:
```bash
npx degit nuxt/starter#v3 my-nuxt3-project
npx degit "nuxt/starter#v3" my-nuxt3-project
```
Open `my-nuxt3-project` folder in visual studio code:

19
docs/content/1.get-started/2.structure.md
View File

@ -2,39 +2,36 @@
The Nuxt application structure is intended to provide a great starting point for both small and large applications. You are free to organize your application however you like and can create them as and when you need.
## The `app.vue` file
### The `app.vue` file
The `app.vue` file, is used as main component for your application ([learn more](/app/app)).
## The `pages/` directory
### The `pages/` directory
The `pages/` directory contains your application's views and routes. If it exists, Nuxt reads all the `.vue` files inside this directory and uses them to create the application router ([learn more](/app/pages)).
## The `plugins/` directory
### The `plugins/` directory
Nuxt will automatically read the files in your `plugins/` directory and load them. ([learn more](/app/plugins)).
## The `/server` directory
### The `server/` directory
The `server/` directory contains API endpoints and server middleware for your project. ([learn more](/server/api)).
## The `components/` directory
### The `components/` directory
The `components/` directory is where you put all your Vue components which can then be imported inside your pages or other components.
## The `assets/` directory
### The `assets/` directory
The `assets/` directory contains your uncompiled assets such as your styles or fonts.
## The `static/` directory
### The `static/` directory
The `static/` directory is directly served at server root and contains public files that have to keep their names (e.g. `robots.txt`) _or_ likely won't change (e.g. `favicon.ico`).
## The `nuxt.config` file
### The `nuxt.config` file
The `nuxt.config` (`js` or `ts`) file is the single point of configuration for Nuxt. If you want to add modules or override default settings, this is the place to apply the changes.