Skip to content

Commit 15b6c75

Browse files
committed
docs: fix textlint
1 parent daa6404 commit 15b6c75

File tree

8 files changed

+26
-29
lines changed

8 files changed

+26
-29
lines changed

changelog-unpublished/1.9/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
118118
119119
### Context API
120120
121-
VuePress's configuration can also be a function, while its first parameter is the current [app context](https://vuepress.vuejs.org/plugin/context-api.html#context-api):
121+
VuePresss configuration can also be a function, while its first parameter is the current [app context](https://vuepress.vuejs.org/plugin/context-api.html#context-api):
122122
123123
```ts
124124
import { defineConfig } from "vuepress/config";
@@ -131,7 +131,7 @@ export default defineConfig(ctx => ({
131131
132132
## Limitations
133133
134-
It is worth noting that third-party plugins do not support [Plugin Shorthand](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-shorthand) if you're using [Tuple Style](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
134+
It is worth noting that third-party plugins do not support [Plugin Shorthand](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-shorthand) if youre using [Tuple Style](https://vuepress.vuejs.org/plugin/using-a-plugin.html#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
135135
136136
By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
137137

packages/@vuepress/markdown/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ console.log(isRequiredPlugin(PLUGINS.HIGHLIGHT_LINES)) // false
2222

2323
Remove the specified built-in markdown-it plugin in VuePress.
2424

25-
It's needed to use with VuePress's [Plugin API > chainMarkdown](https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown).
25+
It's needed to use with VuePresss [Plugin API > chainMarkdown](https://vuepress.vuejs.org/plugin/option-api.html#chainmarkdown).
2626

2727
- **Usage**:
2828

packages/docs/.textlint.terms.json

-8
This file was deleted.

packages/docs/.textlintrc.js

+16-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
module.exports = {
22
rules: {
3-
'@textlint-rule/no-unmatched-pair': true,
3+
"@textlint-rule/no-unmatched-pair": true,
44
apostrophe: true,
5-
'common-misspellings': true,
5+
"common-misspellings": true,
66
diacritics: true,
7-
'en-capitalization': {
8-
allowHeading: false
9-
},
10-
'stop-words': {
11-
severity: 'warning'
7+
"en-capitalization": false,
8+
"stop-words": {
9+
severity: "warning"
1210
},
1311
terminology: {
14-
terms: `${__dirname}/.textlint.terms.json`
12+
terms: [
13+
"VuePress",
14+
"sass",
15+
[
16+
"front[- ]matter",
17+
"frontmatter"
18+
]
19+
]
1520
},
16-
'write-good': {
17-
severity: 'warning'
21+
"write-good": {
22+
severity: "warning"
1823
}
1924
},
2025
filters: {
2126
comments: true
2227
}
23-
}
28+
};

packages/docs/docs/guide/deploy.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ You can also run the above script in your CI setup to enable automatic deploymen
5757
:::
5858

5959
::: tip
60-
When you use a **Custom Domain name**, you MUST add the CNAME file into /docs/.vuepress/public folder (Create the folder if it isn't there). Otherwise, your CNAME file will always be removed with each deploy and never work.
60+
When you use a **Custom Domain name**, you MUST add the CNAME file into /docs/.vuepress/public folder (Create the folder if it isnt there). Otherwise, your CNAME file will always be removed with each deploy and never work.
6161
:::
6262

6363

6464
### GitHub Pages and GitHub Actions
6565

6666
1. [Create a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token);
6767
2. Create [encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) under your repository;
68-
3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g:`vuepress-deploy.yml`:
68+
3. Create a `.yml` or `.yaml` file in the `.github/workflows` directory in the root of your repository. e.g. `vuepress-deploy.yml`:
6969

7070
```yml
7171
name: Build and Deploy

packages/docs/docs/guide/typescript-as-config.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The illustration snapshot is omitted here, you can try it yourself.
101101

102102
## Third Plugins
103103

104-
It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you're using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
104+
It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if youre using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
105105

106106
By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
107107

@@ -113,7 +113,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
113113

114114
## Context API
115115

116-
VuePress's configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
116+
VuePresss configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
117117

118118
```ts
119119
import { defineConfig } from "vuepress/config";

packages/docs/docs/zh/guide/typescript-as-config.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The illustration snapshot is omitted here, you can try it yourself.
101101

102102
## Third Plugins
103103

104-
It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if you're using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
104+
It is worth noting that third-party plugins do not support [Plugin Shorthand](../plugin/using-a-plugin.md#plugin-shorthand) if youre using [Tuple Style](../plugin/using-a-plugin.md#plugin-options) to write your config, this is because from the perspective of the type system, the unknown shortcut is equivalent to `string`, which results in the failure of type inference.
105105

106106
By default, only officially maintained and plugins under [VuePress Community](https://vuepress-community.netlify.app/en/) support shortcut, feel free to submit pull request to add your plugin at this [file](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/types/third-party-plugins.ts).
107107

@@ -113,7 +113,7 @@ Type inference supports [ISO Language Code](http://www.lingoes.net/en/translator
113113

114114
## Context API
115115

116-
VuePress's configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
116+
VuePresss configuration can also be a function, while its first parameter is the current [app context](../plugin/context-api.md#context-api):
117117

118118
```ts
119119
import { defineConfig } from "vuepress/config";

rfcs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ You should consider using this process if you intend to make `"substantial"` cha
3131
- The author of an RFC is not obligated to implement it. Of course, the RFC author (like any other developer) is welcome to post an implementation for review after the RFC has been accepted.
3232
- If you are interested in working on the implementation for an `'active'` RFC, but cannot determine if someone else is already working on it, feel free to ask (e.g. by leaving a comment on the associated issue).
3333
- It's worth noting that even if RFC becomes `'active'`, it doesn't mean that the pull request of this implementation will eventually be merged.
34-
- **VuePress's RFC process owes its inspiration to the [Yarn RFC process]**.
34+
- **VuePresss RFC process owes its inspiration to the [Yarn RFC process]**.
3535

3636
[Yarn RFC process]: https://github.com/yarnpkg/rfcs

0 commit comments

Comments
 (0)