Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-25 23:22:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(features): complete assets page (#4563)

Browse Source 
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
Co-authored-by: Damian <48835293+DamianGlowala@users.noreply.github.com>
Co-authored-by: pooya parsa <pyapar@gmail.com>
This commit is contained in:
Clément Ollivier 2022-04-27 18:21:32 +02:00 committed by GitHub
parent 7e912e7bf4
commit 8424165258
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/content/2.guide/2.features/3.assets.md
View File

@ -1,10 +1,44 @@
# Assets
::NeedContribution
::
Nuxt uses two directories to handle assets like stylesheets, fonts or images:
::ReadMore{link="/guide/directory-structure/assets"}
::
- The [`public/` directory](/guide/directory-structure/public) content is served at the server root as-is.
- The [`assets/` directory](/guide/directory-structure/assets) contains by convention every asset that you want the build tool (Vite or Webpack) to process.
::ReadMore{link="/guide/directory-structure/public"}
## `public/` directory
The [`public/` directory](/guide/directory-structure/public) is used as a public server for static assets publicly available at a defined URL of your application.
You can get a file in the `public/` directory from your application's code or from a browser by the root URL `/`.
### Example
For example, referencing an image file in the `public/img/` directory, available at the static URL `/img/nuxt.png`:
```vue [app.vue]
<template>
<img src="/img/nuxt.png" alt="Discover Nuxt 3" />
</template>
```
## `assets/` directory
Nuxt uses [Vite](https://vitejs.dev/guide/assets.html) or [Webpack](https://webpack.js.org/guides/asset-management/) to build and bundle your application. The main function of these build tools is to process JavaScript files, but they can be extended through [plugins](https://vitejs.dev/plugins/) (for Vite) or [loaders](https://webpack.js.org/loaders/) (for Webpack) to process other kind of assets, like stylesheets, fonts or SVG. This step transforms the original file mainly for performance or caching purposes (such as stylesheets minification or browser cache invalidation).
By convention, Nuxt uses the `assets/` directory to store these files but there is no auto-scan functionality for this directory, and you can use any other name for it.
In your application's code, you can reference a file located in the `assets/` directory by using the `~/assets/` path.
### Example
For example, referencing an image file that will be processed if a build tool is configured to handle this file extension:
```vue [app.vue]
<template>
<img src="~/assets/img/nuxt.png" alt="Discover Nuxt 3" />
</template>
```
::alert{type=info icon=💡}
Nuxt won't serve files in the `assets/` directory at a static URL like `/assets/my-file.png`. If you need a static URL, use the [`public/` directory](#public-directory).
::