From 29b8f76b236f6e6e47c32d0672de9f602ee3ad83 Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 19 Jul 2023 13:38:10 +0530 Subject: [PATCH] chore: format --- docs/guide/deploy.md | 6 +++--- docs/guide/extending-default-theme.md | 4 ++-- docs/guide/getting-started.md | 4 ++-- docs/guide/routing.md | 4 ++-- docs/guide/using-vue.md | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md index 581c5ae7..6ab0773c 100644 --- a/docs/guide/deploy.md +++ b/docs/guide/deploy.md @@ -45,7 +45,7 @@ The following guides are based on some shared assumptions: } ``` -Now the `docs:preview` method will launch the server at `http://localhost:8080`. + Now the `docs:preview` method will launch the server at `http://localhost:8080`. ## Setting a Public Base Path @@ -65,7 +65,7 @@ This `4f283b18` hash is generated from the content of this file. The same hashed Cache-Control: max-age=31536000,immutable ``` -:::details Example Netlify `_headers` file +::: details Example Netlify `_headers` file ``` /assets/* @@ -79,7 +79,7 @@ Note: the `_headers` file should be placed in the [public directory](/guide/asse ::: -:::details Example Vercel config in `vercel.json` +::: details Example Vercel config in `vercel.json` ```json { diff --git a/docs/guide/extending-default-theme.md b/docs/guide/extending-default-theme.md index b568ca1d..a0ccfd9e 100644 --- a/docs/guide/extending-default-theme.md +++ b/docs/guide/extending-default-theme.md @@ -10,7 +10,7 @@ However, there are a number of cases where configuration alone won't be enough. These advanced customizations will require using a custom theme that "extends" the default theme. -:::tip +::: tip Before proceeding, make sure to first read [Using a Custom Theme](./custom-theme) to understand how custom themes work. ::: @@ -58,7 +58,7 @@ export default DefaultTheme } ``` -:::warning +::: warning If you are using optional components like the [Team Page](/reference/default-theme-team-page) components, make sure to also import them from `vitepress/theme-without-fonts`! ::: diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 954ad2cb..5bea2b76 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -69,7 +69,7 @@ You will be greeted with a few simple questions: vitepress init screenshot

-:::tip Vue as Peer Dependency +::: tip Vue as Peer Dependency If you intend to perform customization that uses Vue components or APIs, you should also explicitly install `vue` as a peer dependency. ::: @@ -92,7 +92,7 @@ Assuming you chose to scaffold the VitePress project in `./docs`, the generated The `docs` directory is considered the **project root** of the VitePress site. The `.vitepress` directory is a reserved location for VitePress' config file, dev server cache, build output, and optional theme customization code. -:::tip +::: tip By default, VitePress stores its dev server cache in `.vitepress/cache`, and the production build output in `.vitepress/dist`. If using Git, you should add them to your `.gitignore` file. These locations can also be [configured](../reference/site-config#outdir). ::: diff --git a/docs/guide/routing.md b/docs/guide/routing.md index 89b6003f..f5fa9bff 100644 --- a/docs/guide/routing.md +++ b/docs/guide/routing.md @@ -97,7 +97,7 @@ Learn more about linking to assets such images in [Asset Handling](asset-handlin ## Generating Clean URL -:::warning Server Support Required +::: warning Server Support Required To serve clean URLs with VitePress, server-side support is required. ::: @@ -172,7 +172,7 @@ export default { The rewrite paths are compiled using the `path-to-regexp` package - consult [its documentation](https://github.com/pillarjs/path-to-regexp#parameters) for more advanced syntax. -:::warning Relative Links with Rewrites +::: warning Relative Links with Rewrites When rewrites are enabled, **relative links should be based on the rewritten paths**. For example, in order to create a relative link from `packages/pkg-a/src/pkg-a-code.md` to `packages/pkg-b/src/pkg-b-code.md`, you should use: diff --git a/docs/guide/using-vue.md b/docs/guide/using-vue.md index 77a6407e..3511ded0 100644 --- a/docs/guide/using-vue.md +++ b/docs/guide/using-vue.md @@ -4,7 +4,7 @@ In VitePress, each Markdown file is compiled into HTML and then processed as a [ It's worth noting that VitePress leverages Vue's compiler to automatically detect and optimize the purely static parts of the Markdown content. Static contents are optimized into single placeholder nodes and eliminated from the page's JavaScript payload for initial visits. They are also skipped during client-side hydration. In short, you only pay for the dynamic parts on any given page. -:::tip SSR Compatibility +::: tip SSR Compatibility All Vue usage needs to be SSR-compatible. See [SSR Compatibility](./ssr-compat) for details and common workarounds. ::: @@ -67,7 +67,7 @@ The count is: {{ count }} ``` -:::warning Avoid `