From 615e4b55385ac35c424496339fa5ce7125d43dfa Mon Sep 17 00:00:00 2001 From: Polaris <37720445+PolarisWasInDenial@users.noreply.github.com> Date: Thu, 18 Jul 2024 02:08:13 -0500 Subject: [PATCH 01/25] Minor SPAG edits --- docs/en/guide/asset-handling.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/guide/asset-handling.md b/docs/en/guide/asset-handling.md index eeedc8c02565..01f13b70da84 100644 --- a/docs/en/guide/asset-handling.md +++ b/docs/en/guide/asset-handling.md @@ -8,9 +8,9 @@ All Markdown files are compiled into Vue components and processed by [Vite](http ![An image](./image.png) ``` -You can reference static assets in your markdown files, your `*.vue` components in the theme, styles and plain `.css` files either using absolute public paths (based on project root) or relative paths (based on your file system). The latter is similar to the behavior you are used to if you have used Vite, Vue CLI, or webpack's `file-loader`. +You can reference static assets in your markdown files, your `*.vue` components in the theme, styles, and plain `.css` files either using absolute public paths (based on project root) or relative paths (based on your file system). The latter is similar to the behavior you are used to if you have used Vite, Vue CLI, or webpack's `file-loader`. -Common image, media, and font filetypes are detected and included as assets automatically. +Common image, media, and font file types are detected and included as assets automatically. ::: tip Linked files are not treated as assets PDFs or other documents referenced by links within markdown files are not automatically treated as assets. To make linked files accessible, you must manually place them within the [`public`](#the-public-directory) directory of your project. @@ -24,11 +24,11 @@ All **static** path references, including absolute paths, should be based on you 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 `robots.txt`, favicons, and PWA icons. -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`. +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 the 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. -Note that you should reference files placed in `public` using root absolute path - for example, `public/icon.png` should always be referenced in source code as `/icon.png`. +Note that you should reference files placed in `public` using the root absolute path - for example, `public/icon.png` should always be referenced in source code as `/icon.png`. ## Base URL @@ -48,7 +48,7 @@ However, if you are authoring a theme component that links to assets dynamically ``` -In this case it is recommended to wrap the path with the [`withBase` helper](../reference/runtime-api#withbase) provided by VitePress: +In this case, it is recommended to wrap the path with the [`withBase` helper](../reference/runtime-api#withbase) provided by VitePress: ```vue