From f005b0c00480a3a239625eb0e6cdcde3ce3007ad Mon Sep 17 00:00:00 2001 From: Billyyyyy3320 Date: Wed, 22 Jul 2020 00:46:43 +0800 Subject: [PATCH] docs: lint and format --- packages/docs/docs/guide/assets.md | 2 +- packages/docs/docs/guide/deploy.md | 8 ++++---- packages/docs/docs/guide/directory-structure.md | 2 +- packages/docs/docs/guide/frontmatter.md | 2 +- packages/docs/docs/guide/global-computed.md | 4 ++-- packages/docs/docs/guide/markdown.md | 12 ++++++------ packages/docs/docs/guide/permalinks.md | 2 +- packages/docs/docs/plugin/README.md | 2 +- 8 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/docs/docs/guide/assets.md b/packages/docs/docs/guide/assets.md index 7273b1922b..ca776013a0 100644 --- a/packages/docs/docs/guide/assets.md +++ b/packages/docs/docs/guide/assets.md @@ -2,7 +2,7 @@ ## Relative URLs -All Markdown files are compiled into Vue components and processed by [webpack](http://webpack.js.org/). You can, **and should **, reference any assets using relative URLs: +All Markdown files are compiled into Vue components and processed by [webpack](http://webpack.js.org/). You can, **and should**, reference any assets using relative URLs: ``` md ![An image](./image.png) diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index 35cbf6396f..a5d804a84f 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -20,7 +20,7 @@ The following guides are based on some shared assumptions: If you are deploying to `https://.github.io/`, you can omit `base` as it defaults to `"/"`. - If you are deploying to `https://.github.io//`, e.g. your repository is at `https://github.com//`, then set `base` to `"//"`. + If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `"//"`. 2. Inside your project, create `deploy.sh` with the following content (with highlighted lines uncommented appropriately), and run it to deploy: @@ -62,11 +62,11 @@ You can also run the above script in your CI setup to enable automatic deploymen If you are deploying to `https://.github.io/`, you can omit `base` as it defaults to `"/"`. - If you are deploying to `https://.github.io//`, e.g. your repository is at `https://github.com//`, then set `base` to `"//"`. + If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `"//"`. 2. Create a file named `.travis.yml` in the root of your project. -3. Run `yarn` or `npm install` locally and commit the generated lockfile (i.e. `yarn.lock` or `package-lock.json`). +3. Run `yarn` or `npm install` locally and commit the generated lockfile (that is `yarn.lock` or `package-lock.json`). 4. Use the GitHub Pages deploy provider template, and follow the [Travis CI documentation](https://docs.travis-ci.com/user/deployment/pages/). @@ -94,7 +94,7 @@ deploy: If you are deploying to `https://.gitlab.io/`, you can omit `base` as it defaults to `"/"`. - If you are deploying to `https://.gitlab.io//`, e.g. your repository is at `https://gitlab.com//`, then set `base` to `"//"`. + If you are deploying to `https://.gitlab.io//`, for example your repository is at `https://gitlab.com//`, then set `base` to `"//"`. 2. Set `dest` in `.vuepress/config.js` to `public`. diff --git a/packages/docs/docs/guide/directory-structure.md b/packages/docs/docs/guide/directory-structure.md index 210abacb6c..9bde09ea4e 100644 --- a/packages/docs/docs/guide/directory-structure.md +++ b/packages/docs/docs/guide/directory-structure.md @@ -54,7 +54,7 @@ When customizing `templates/ssr.html`, or `templates/dev.html`, it’s best to e ## Default Page Routing -Here we use the `docs` directory as the `targetDir` (see [Command-line Interface](../api/cli.md#usage)). All the "Relative Paths" below are relative to the `docs` directory. Add `scripts` in `package.json` which is located in your project's root directory: +Here we use the `docs` directory as the `targetDir` (see [Command-line Interface](../api/cli.md#usage)). All the "Relative Paths" below are relative to the `docs` directory. Add `scripts` in `package.json` which is located in your project’s root directory: ```json { diff --git a/packages/docs/docs/guide/frontmatter.md b/packages/docs/docs/guide/frontmatter.md index 699d40fb47..39a0d2d76b 100644 --- a/packages/docs/docs/guide/frontmatter.md +++ b/packages/docs/docs/guide/frontmatter.md @@ -152,4 +152,4 @@ See [Default Theme Config > Built-in Search](../theme/default-theme-config.html# - Type: `array` - Default: `undefined` -See [Default Theme Config > Built-in Search](../theme/default-theme-config.html#built-in-search). for details. +See [Default Theme Config > Built-in Search](../theme/default-theme-config.html#built-in-search). For details. diff --git a/packages/docs/docs/guide/global-computed.md b/packages/docs/docs/guide/global-computed.md index cc1be486e2..c4d328f73f 100644 --- a/packages/docs/docs/guide/global-computed.md +++ b/packages/docs/docs/guide/global-computed.md @@ -4,7 +4,7 @@ In VuePress, some core [computed properties](https://vuejs.org/v2/guide/computed ## $site -This is the `$site` value of the site you're currently reading: +This is the `$site` value of the site you’re currently reading: ``` json { @@ -25,7 +25,7 @@ This is the `$site` value of the site you're currently reading: ## $page -This is the `$page` value of the page you're currently reading: +This is the `$page` value of the page you’re currently reading: ``` json { diff --git a/packages/docs/docs/guide/markdown.md b/packages/docs/docs/guide/markdown.md index ff704e8d79..96f81ad32d 100644 --- a/packages/docs/docs/guide/markdown.md +++ b/packages/docs/docs/guide/markdown.md @@ -159,7 +159,7 @@ This is a dangerous warning ::: ::: details -This is a details block, which does not work in IE / Edge +This is a details block, which does not work in That is / Edge ::: ### Custom Title @@ -245,7 +245,7 @@ export default { ``` -A [list of valid languages](https://prismjs.com/#languages-list) is available on Prism's site. +A [list of valid languages](https://prismjs.com/#languages-list) is available on Prism’s site. ## Line Highlighting in Code Blocks @@ -277,9 +277,9 @@ export default { In addition to a single line, you can also specify multiple single lines, ranges, or both: -- Line ranges: e.g. `{5-8}`, `{3-10}`, `{10-17}` -- Multiple single lines: e.g. `{4,7,9}` -- Line ranges and single lines: e.g. `{4,7-13,16,23-27,40}` +- Line ranges: for example `{5-8}`, `{3-10}`, `{10-17}` +- Multiple single lines: for example `{4,7,9}` +- Line ranges and single lines: for example `{4,7-13,16,23-27,40}` **Input** @@ -391,7 +391,7 @@ It also supports [line highlighting](#line-highlighting-in-code-blocks): Since the import of the code snippets will be executed before webpack compilation, you can’t use the path alias in webpack. The default value of `@` is `process.cwd()`. ::: -You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) in order to only include the corresponding part of the code file. You can provide a custom region name after a `#` following the filepath (`snippet` by default): +You can also use a [VS Code region](https://code.visualstudio.com/docs/editor/codebasics#_folding) to only include the corresponding part of the code file. You can provide a custom region name after a `#` following the filepath (`snippet` by default): **Input** diff --git a/packages/docs/docs/guide/permalinks.md b/packages/docs/docs/guide/permalinks.md index 242161b0cd..6fda16546f 100644 --- a/packages/docs/docs/guide/permalinks.md +++ b/packages/docs/docs/guide/permalinks.md @@ -50,7 +50,7 @@ module.exports = { You can also set set a permalink for a single page only. This overrides the aforementioned global setting: -📝 __hello.md__: +📝 **hello.md**: ```markdown --- diff --git a/packages/docs/docs/plugin/README.md b/packages/docs/docs/plugin/README.md index 503144f307..6695160588 100644 --- a/packages/docs/docs/plugin/README.md +++ b/packages/docs/docs/plugin/README.md @@ -15,7 +15,7 @@ Here is also a little slightly complicated plugin example [@vuepress/plugin-blog ## Out of the Box -To keep things at a minimum, not all of the official plugins are shipped with VuePress. Here is the list of plugins that are pre-installed in the VuePress and the default theme, **plugins that are not in the list below need to be installed manually**(e.g. [@vuepress/plugin-back-to-top](./official/plugin-back-to-top.md)). +To keep things at a minimum, not all of the official plugins are shipped with VuePress. Here is the list of plugins that are pre-installed in the VuePress and the default theme, **plugins that are not in the list below need to be installed manually**(for example [@vuepress/plugin-back-to-top](./official/plugin-back-to-top.md)). ### Plugins that come with VuePress