Skip to content

Commit

Permalink
docs: lint and format (#2513)
Browse files Browse the repository at this point in the history
Co-authored-by: Ben Hong <ben@bencodezen.io>
  • Loading branch information
billyyyyy3320 and bencodezen committed Jul 23, 2020
1 parent 0aa0368 commit 18b2198
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
8 changes: 4 additions & 4 deletions packages/docs/docs/guide/deploy.md
Expand Up @@ -20,7 +20,7 @@ The following guides are based on some shared assumptions:

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

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>/"`.
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>/"`.

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

Expand Down Expand Up @@ -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://<USERNAME or GROUP>.github.io/`, you can omit `base` as it defaults to `"/"`.

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>/"`.
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>/"`.

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/).

Expand Down Expand Up @@ -94,7 +94,7 @@ deploy:

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

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>/"`.
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>/"`.

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

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/guide/frontmatter.md
Expand Up @@ -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.
10 changes: 5 additions & 5 deletions packages/docs/docs/guide/markdown.md
Expand Up @@ -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
Expand Down Expand Up @@ -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**

Expand Down Expand Up @@ -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**

Expand Down
2 changes: 1 addition & 1 deletion packages/docs/docs/plugin/README.md
Expand Up @@ -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

Expand Down

0 comments on commit 18b2198

Please sign in to comment.