From 295ee65bf8a3987beda56001d5c65102c1302014 Mon Sep 17 00:00:00 2001 From: Endi Date: Fri, 12 Jul 2019 11:01:37 +0700 Subject: [PATCH] docs(v2): add docs on static assets (#1648) * docs(v2 ): add docs on static assets * Update static-assets.md --- website/docs/static-assets.md | 43 +++++++++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/website/docs/static-assets.md b/website/docs/static-assets.md index 55688c1114..0d2d9c5a52 100644 --- a/website/docs/static-assets.md +++ b/website/docs/static-assets.md @@ -3,15 +3,40 @@ id: static-assets title: Static Assets --- -_This section is a work in progress. [Welcoming PRs](https://github.com/facebook/docusaurus/issues/1640)._ +In general, every website needs assets: images, stylesheets, favicons and etc. In such cases, +you can create a folder named `static` at the root of your project. Every file you put into that folder will be copied into the generated build folder. E.g. if you add a file named `sun.jpg` to the static folder, it’ll be copied to `build/sun.jpg` -A "how-to" guide on including static assets within pages and docs. +This means that if the site's baseUrl is `/`, an image in `static/img/docusaurus_keytar.svg` is available at `docusaurus_keytar.svg`. - +## Referencing your static asset + +You can reference assets from the static folder in your code with absolute path, i.e. starting with a slash /. + +Markdown example: + +```markdown + +![docusaurus logo](/img/docusaurus.png) +``` + +Result: + +![docusaurus logo](/img/docusaurus.png) + +JSX example: + +```jsx +// reference static/img/slash-birth.png +docusaurus mascot +``` + +Result: + +docusaurus mascot + + +Keep in mind that: + +- None of the files in static folder will be post-processed or minified. +- Missing files will not be called at compilation time, and will cause 404 errors for your users.