From 31b548c718a51a319a745467801e50aee74bed1b Mon Sep 17 00:00:00 2001 From: Evan You Date: Mon, 13 Mar 2023 14:04:37 +0800 Subject: [PATCH] docs: fix location description of the public dir Should be relative to srcDir instead of project root --- docs/guide/asset-handling.md | 8 ++++++-- docs/guide/deploy.md | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/guide/asset-handling.md b/docs/guide/asset-handling.md index 711be2d1..c914bf31 100644 --- a/docs/guide/asset-handling.md +++ b/docs/guide/asset-handling.md @@ -1,5 +1,7 @@ # Asset Handling +## Referencing Static Assets + All Markdown files are compiled into Vue components and processed by [Vite](https://vitejs.dev/guide/assets.html). You can, **and should**, reference any assets using relative URLs: ```md @@ -14,9 +16,11 @@ All referenced assets, including those using absolute paths, will be copied to t All **static** path references, including absolute paths, should be based on your working directory structure. -## Public Files +## The Public Directory + +Sometimes you may need to provide static assets that are not directly referenced in any of your Markdown or theme components, or you may want to serve certain files with the original filename. Examples of such files include `robot.txt`, favicons, and PWA icons. -Sometimes you may need to provide static assets that are not directly referenced in any of your Markdown or theme components (for example, favicons and PWA icons). The `public` directory under [project root](./routing#project-root) (`docs` folder if you're running `vitepress build docs`) can be used as an escape hatch to provide static assets that either are never referenced in source code (e.g. `robots.txt`), or must retain the exact same file name (without hashing). +You can place these files in the `public` directory under the [source directory](./routing#source-directory). For example, if your project root is `./docs` and using default source directory location, then your public directory will be `./docs/public`. Assets placed in `public` will be copied to the root of the output directory as-is. diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md index 564681f4..56511b91 100644 --- a/docs/guide/deploy.md +++ b/docs/guide/deploy.md @@ -73,7 +73,7 @@ Cache-Control: max-age=31536000,immutable cache-control: immutable ``` -Note: the `_headers` file should be placed in the [public directory](/guide/asset-handling#public-files) - in our case, `docs/public/_headers` - so that it is copied verbatim to the output directory. +Note: the `_headers` file should be placed in the [public directory](/guide/asset-handling#the-public-directory) - in our case, `docs/public/_headers` - so that it is copied verbatim to the output directory. [Netlify custom headers documentation](https://docs.netlify.com/routing/headers/)