Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 7 commits into from
Jun 12, 2023
Merged

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

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f61a58f
Update static assets pages to exclude <PagesOnly> information
delbaoliveira Jun 12, 2023
be41b08
Merge branch 'canary' into docs-gf03
delbaoliveira Jun 12, 2023
d94000a
Update docs/02-app/01-building-your-application/05-optimizing/05-stat…
delbaoliveira Jun 12, 2023
121b4f1
Merge branch 'canary' into docs-gf03
delbaoliveira Jun 12, 2023
b1a5457
Add note about static metadata files in app
delbaoliveira Jun 12, 2023
0a5ff1f
title → filename
manovotny Jun 12, 2023
da3e985
Merge branch 'canary' into docs-gf03
manovotny Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/02-app/01-building-your-application/05-optimizing/05-static-assets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>

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>
delbaoliveira marked this conversation as resolved.
Show resolved Hide resolved

<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>

- 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.
> 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.