Skip to content

Commit

Permalink
Clarify documentation regarding the static folder (#4340)
Browse files Browse the repository at this point in the history
  • Loading branch information
tvthatsme authored and timneutkens committed May 25, 2018
1 parent 4df7e48 commit a806c16
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ So far, we get:
- Automatic transpilation and bundling (with webpack and babel)
- Hot code reloading
- Server rendering and indexing of `./pages`
- Static file serving. `./static/` is mapped to `/static/`
- Static file serving. `./static/` is mapped to `/static/` (given you [create a `./static/` directory](#static-file-serving-eg-images) inside your project)

To see how simple this is, check out the [sample app - nextgram](https://github.com/zeit/nextgram)

Expand Down Expand Up @@ -208,6 +208,8 @@ Create a folder called `static` in your project root directory. From your code y
export default () => <img src="/static/my-image.png" alt="my image" />
```

_Note: Don't name the `static` directory anything else. The name is required and is the only directory that Next.js uses for serving static assets._

### Populating `<head>`

<p><details>
Expand Down

0 comments on commit a806c16

Please sign in to comment.