From 12ca9dd3c736bb8b3938452c36b316ec0396ef6a Mon Sep 17 00:00:00 2001 From: Divyansh Singh <40380293+brc-dd@users.noreply.github.com> Date: Wed, 16 Nov 2022 13:49:40 +0530 Subject: [PATCH] docs: remove special characters --- docs/config/frontmatter-configs.md | 2 +- docs/guide/frontmatter.md | 2 +- docs/guide/markdown.md | 14 +++++++------- docs/guide/using-vue.md | 2 +- docs/guide/what-is-vitepress.md | 6 +++--- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/config/frontmatter-configs.md b/docs/config/frontmatter-configs.md index ff416440..f372368d 100644 --- a/docs/config/frontmatter-configs.md +++ b/docs/config/frontmatter-configs.md @@ -1,6 +1,6 @@ # Frontmatter Configs -Frontmatter enables page based configuration. On every markdown, you’re free to add Any settings to override any global app or theme configs. Also, there are configs which you can only define in Frontmatter. +Frontmatter enables page based configuration. On every markdown, you're free to add Any settings to override any global app or theme configs. Also, there are configs which you can only define in Frontmatter. ```yaml --- diff --git a/docs/guide/frontmatter.md b/docs/guide/frontmatter.md index c3dbcd29..9f933318 100644 --- a/docs/guide/frontmatter.md +++ b/docs/guide/frontmatter.md @@ -11,7 +11,7 @@ editLink: true Between the triple-dashed lines, you can set [predefined variables](../config/frontmatter-configs), or even create custom ones of your own. These variables can be used via the special $frontmatter variable. -Here’s an example of how you could use it in your Markdown file: +Here's an example of how you could use it in your Markdown file: ```md --- diff --git a/docs/guide/markdown.md b/docs/guide/markdown.md index 6c25b1a1..79bd77b1 100644 --- a/docs/guide/markdown.md +++ b/docs/guide/markdown.md @@ -279,7 +279,7 @@ export default { ``` -A [list of valid languages](https://github.com/shikijs/shiki/blob/main/docs/languages.md) is available on Shiki’s repository. +A [list of valid languages](https://github.com/shikijs/shiki/blob/main/docs/languages.md) is available on Shiki's repository. You may also customize syntax highlight theme in app config. Please see [`markdown` options](../config/app-configs#markdown) for more details. @@ -360,7 +360,7 @@ Alternatively, it's possible to highlight directly in the line by using the `// export default { data () { return { - msg: 'Highlighted!' // [!codeㅤ hl] + msg: 'Highlighted!' // [!code hl] } } } @@ -392,7 +392,7 @@ Additionally, you can define a number of lines to focus using `// [!code focus:< export default { data () { return { - msg: 'Focused!' // [!codeㅤ focus] + msg: 'Focused!' // [!code focus] } } } @@ -422,8 +422,8 @@ Adding the `// [!code --]` or `// [!code ++]` comments on a line will create a d export default { data () { return { - msg: 'Removed' // [!codeㅤ --] - msg: 'Added' // [!codeㅤ ++] + msg: 'Removed' // [!code --] + msg: 'Added' // [!code ++] } } } @@ -454,8 +454,8 @@ Adding the `// [!code warning]` or `// [!code error]` comments on a line will co export default { data () { return { - msg: 'Error', // [!codeㅤ error] - msg: 'Warning' // [!codeㅤ warning] + msg: 'Error', // [!code error] + msg: 'Warning' // [!code warning] } } } diff --git a/docs/guide/using-vue.md b/docs/guide/using-vue.md index 600600ea..69ba1dd5 100644 --- a/docs/guide/using-vue.md +++ b/docs/guide/using-vue.md @@ -129,7 +129,7 @@ Later in your markdown files, the component can be interleaved between the conte ``` ::: warning IMPORTANT -Make sure a custom component’s name either contains a hyphen or is in PascalCase. Otherwise, it will be treated as an inline element and wrapped inside a `

` tag, which will lead to hydration mismatch because `

` does not allow block elements to be placed inside it. +Make sure a custom component's name either contains a hyphen or is in PascalCase. Otherwise, it will be treated as an inline element and wrapped inside a `

` tag, which will lead to hydration mismatch because `

` does not allow block elements to be placed inside it. ::: ### Using Components In Headers diff --git a/docs/guide/what-is-vitepress.md b/docs/guide/what-is-vitepress.md index cd4a0be2..2c5e85ae 100644 --- a/docs/guide/what-is-vitepress.md +++ b/docs/guide/what-is-vitepress.md @@ -10,7 +10,7 @@ VitePress is currently in `alpha` status. It is already suitable for out-of-the- We love VuePress v1, but being built on top of Webpack, the time it takes to spin up the dev server for a simple doc site with a few pages is just becoming unbearable. Even HMR updates can take up to seconds to reflect in the browser! -Fundamentally, this is because VuePress v1 is a Webpack app under the hood. Even with just two pages, it's a full on Webpack project (including all the theme source files) being compiled. It gets even worse when the project has many pages – every page must first be fully compiled before the server can even display anything! +Fundamentally, this is because VuePress v1 is a Webpack app under the hood. Even with just two pages, it's a full on Webpack project (including all the theme source files) being compiled. It gets even worse when the project has many pages - every page must first be fully compiled before the server can even display anything! Incidentally, Vite solves these problems really well: nearly instant server start, an on-demand compilation that only compiles the page being served, and lightning-fast HMR. Plus, there are a few additional design issues I have noted in VuePress v1 over time but never had the time to fix due to the amount of refactoring it would require. @@ -22,9 +22,9 @@ There're couple of things that are improved from VuePress v1.... ### It uses Vue 3 -Leverages Vue 3's improved template static analysis to stringify static content as much as possible. Static content is sent as string literals instead of JavaScript render function code – the JS payload is therefore much cheaper to parse, and hydration also becomes faster. +Leverages Vue 3's improved template static analysis to stringify static content as much as possible. Static content is sent as string literals instead of JavaScript render function code - the JS payload is therefore much cheaper to parse, and hydration also becomes faster. -Note the optimization is applied while still allowing the user to freely mix Vue components inside markdown content – the compiler does the static/dynamic separation for you automatically and you never need to think about it. +Note the optimization is applied while still allowing the user to freely mix Vue components inside markdown content - the compiler does the static/dynamic separation for you automatically and you never need to think about it. ### It uses Vite under the hood