Skip to content

Commit 18b2198

Browse files
docs: lint and format (#2513)
Co-authored-by: Ben Hong <[email protected]>
1 parent 0aa0368 commit 18b2198

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

packages/docs/docs/guide/deploy.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The following guides are based on some shared assumptions:
2020

2121
If you are deploying to `https://<USERNAME>.github.io/`, you can omit `base` as it defaults to `"/"`.
2222

23-
If you are deploying to `https://<USERNAME>.github.io/<REPO>/`, e.g. your repository is at `https://github.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
23+
If you are deploying to `https://<USERNAME>.github.io/<REPO>/`, for example your repository is at `https://github.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
2424

2525
2. Inside your project, create `deploy.sh` with the following content (with highlighted lines uncommented appropriately), and run it to deploy:
2626

@@ -62,11 +62,11 @@ You can also run the above script in your CI setup to enable automatic deploymen
6262

6363
If you are deploying to `https://<USERNAME or GROUP>.github.io/`, you can omit `base` as it defaults to `"/"`.
6464

65-
If you are deploying to `https://<USERNAME or GROUP>.github.io/<REPO>/`, e.g. your repository is at `https://github.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
65+
If you are deploying to `https://<USERNAME or GROUP>.github.io/<REPO>/`, for example your repository is at `https://github.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
6666

6767
2. Create a file named `.travis.yml` in the root of your project.
6868

69-
3. Run `yarn` or `npm install` locally and commit the generated lockfile (i.e. `yarn.lock` or `package-lock.json`).
69+
3. Run `yarn` or `npm install` locally and commit the generated lockfile (that is `yarn.lock` or `package-lock.json`).
7070

7171
4. Use the GitHub Pages deploy provider template, and follow the [Travis CI documentation](https://docs.travis-ci.com/user/deployment/pages/).
7272

@@ -94,7 +94,7 @@ deploy:
9494

9595
If you are deploying to `https://<USERNAME or GROUP>.gitlab.io/`, you can omit `base` as it defaults to `"/"`.
9696

97-
If you are deploying to `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`, e.g. your repository is at `https://gitlab.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
97+
If you are deploying to `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`, for example your repository is at `https://gitlab.com/<USERNAME>/<REPO>`, then set `base` to `"/<REPO>/"`.
9898

9999
2. Set `dest` in `.vuepress/config.js` to `public`.
100100

packages/docs/docs/guide/frontmatter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -152,4 +152,4 @@ See [Default Theme Config > Built-in Search](../theme/default-theme-config.html#
152152
- Type: `array`
153153
- Default: `undefined`
154154

155-
See [Default Theme Config > Built-in Search](../theme/default-theme-config.html#built-in-search) for details.
155+
See [Default Theme Config > Built-in Search](../theme/default-theme-config.html#built-in-search). For details.

packages/docs/docs/guide/markdown.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ This is a dangerous warning
159159
:::
160160

161161
::: details
162-
This is a details block, which does not work in IE / Edge
162+
This is a details block, which does not work in That is / Edge
163163
:::
164164

165165
### Custom Title
@@ -277,9 +277,9 @@ export default {
277277

278278
In addition to a single line, you can also specify multiple single lines, ranges, or both:
279279

280-
- Line ranges: e.g. `{5-8}`, `{3-10}`, `{10-17}`
281-
- Multiple single lines: e.g. `{4,7,9}`
282-
- Line ranges and single lines: e.g. `{4,7-13,16,23-27,40}`
280+
- Line ranges: for example `{5-8}`, `{3-10}`, `{10-17}`
281+
- Multiple single lines: for example `{4,7,9}`
282+
- Line ranges and single lines: for example `{4,7-13,16,23-27,40}`
283283

284284
**Input**
285285

@@ -391,7 +391,7 @@ It also supports [line highlighting](#line-highlighting-in-code-blocks):
391391
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()`.
392392
:::
393393

394-
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):
394+
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):
395395

396396
**Input**
397397

packages/docs/docs/plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Here is also a little slightly complicated plugin example [@vuepress/plugin-blog
1515

1616
## Out of the Box
1717

18-
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)).
18+
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)).
1919

2020
### Plugins that come with VuePress
2121

0 commit comments

Comments
 (0)