archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Docs] Update static assets page to filter out <PagesOnly> information (#51180)

Browse source 
Co-authored-by: Michael Novotny <446260+manovotny@users.noreply.github.com>
This commit is contained in:
Delba de Oliveira 2023-06-12 19:25:06 +01:00 committed by GitHub
parent 74225d1945
commit 98351e9398
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/02-app/01-building-your-application/05-optimizing/05-static-assets.mdx
View file

@ -7,18 +7,27 @@ Next.js can serve static files, like images, under a folder called `public` in t
For example, if you add `me.png` inside `public`, the following code will access the image:
```jsx
```jsx filename="Avatar.js"
import Image from 'next/image'
function Avatar() {
export function Avatar() {
return <Image src="/me.png" alt="me" width="64" height="64" />
}
export default Avatar
```
This folder is also useful for `robots.txt`, `favicon.ico`, Google Site Verification, and any other static files (including `.html`)!
<PagesOnly>
- Be sure the directory is named `public`. The name cannot be changed and is the only directory used to serve static assets.
- Be sure to not have a static file with the same name as a file in the `pages/` directory, as this will result in an error. [Read more](/docs/messages/conflicting-public-file-page)
- Only assets that are in the `public` directory at [build time](/docs/app/api-reference/next-cli#build) will be served by Next.js. Files added at runtime won't be available. We recommend using a third party service like [AWS S3](https://aws.amazon.com/s3/) for persistent file storage.
This folder is also useful for `robots.txt`, `favicon.ico`, Google Site Verification, and any other static files (including `.html`). But make sure to not have a static file with the same name as a file in the `pages/` directory, as this will result in an error. [Read more](/docs/messages/conflicting-public-file-page).
</PagesOnly>
<AppOnly>
For static metadata files, such as `robots.txt`, `favicon.ico`, etc, you should use [special metadata files](/docs/app/api-reference/file-conventions/metadata) inside the `app` folder.
</AppOnly>
> Good to know:
>
> - The directory must be named `public`. The name cannot be changed and it's the only directory used to serve static assets.
> - Only assets that are in the `public` directory at [build time](/docs/app/api-reference/next-cli#build) will be served by Next.js. Files added at runtime won't be available. We recommend using a third-party service like [AWS S3](https://aws.amazon.com/s3/) for persistent file storage.