chore(docs): adds remark-lint, fix #1741

Author: sarahdayan

packages/docs/.remarkrc

@@ -0,0 +1,9 @@
+{
+  "plugins": [
+    "preset-lint-recommended",
+    "preset-lint-consistent",
+
+    ["lint-list-item-indent", "space"],
+    ["lint-heading-style", false]
+  ]
+}

packages/docs/docs/guide/deploy.md

@@ -119,8 +119,8 @@ pages:
 
 1. On Netlify, setup up a new project from GitHub with the following settings:
 
-  - **Build Command:** `npm run docs:build` or `yarn docs:build`
-  - **Publish directory:** `docs/.vuepress/dist`
+- **Build Command:** `npm run docs:build` or `yarn docs:build`
+- **Publish directory:** `docs/.vuepress/dist`
 
 2. Hit the deploy button!
 
@@ -169,18 +169,18 @@ You can also deploy to a [custom domain](http://surge.sh/help/adding-a-custom-do
 
 3. Run `heroku login` and fill in your Heroku credentials:
 
- ``` bash
- heroku login
- ```
+   ``` bash
+   heroku login
+   ```
 
 4. Create a file called `static.json` in the root of your project with the content below:
 
- `static.json`:
- ```json
- {
-   "root": "./docs/.vuepress/dist"
- }
- ```
+   `static.json`:
+   ```json
+   {
+     "root": "./docs/.vuepress/dist"
+   }
+   ```
 
 This is the configuration of your site. See more at [heroku-buildpack-static](https://github.com/heroku/heroku-buildpack-static).
 

packages/docs/docs/guide/markdown.md

@@ -111,8 +111,12 @@ A list of all emojis available can be found [here](https://github.com/markdown-i
 
 **Output**
 
+<!--lint disable no-shortcut-reference-link no-undefined-references-->
+
 [[toc]]
 
+<!--lint enable no-shortcut-reference-link no-undefined-references-->
+
 Rendering of TOC can be configured using the [`markdown.toc`](../config/README.md#markdown-toc) option.
 
 ## Custom Containers <Badge text="default theme"/>
@@ -311,8 +315,12 @@ It also supports [line highlighting](#line-highlighting-in-code-blocks):
 
 **Output**
 
+<!--lint disable strong-marker-->
+
 <<< @/../@vuepress/markdown/__tests__/fragments/snippet.js{2}
 
+<!--lint enable strong-marker-->
+
 ::: tip
 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()`.
 :::

packages/docs/docs/guide/permalinks.md

@@ -33,7 +33,7 @@ We have seen the shadow of the blog. Let’s continue to look down.
 
 ## Permalinks
 
-A permalink is a URL that is intended to remain unchanged for a long time, yielding a hyperlink that is less susceptible to link root<sup>[1]</sup>. VuePress supports a flexible way to build permalinks, allowing you to use template variables.
+A permalink is a URL that is intended to remain unchanged for a long time, yielding a hyperlink that is less susceptible to link root<sup>[1][1]</sup>. VuePress supports a flexible way to build permalinks, allowing you to use template variables.
 
 The default permalink is `/:regular`.
 
@@ -64,11 +64,13 @@ Hello!
 ### Template Variables
 
 | Variable | Description |
-|---|---|
-|:year|Published year of posts (4-digit)|
-|:month|Published month of posts (2-digit)|
-|:i_month|Published month of posts (Without leading zeros)|
-|:day|Published day of posts (2-digit)|
-|:i_day|Published day of posts (Without leading zeros)|
-|:slug|Slugified file path (Without extension)|
-|:regular| Permalink generated by VuePress by default, for implementation see [here](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/shared-utils/src/fileToPath.ts) |
+| --- | --- |
+| :year | Published year of posts (4-digit) |
+| :month | Published month of posts (2-digit) |
+| :i_month | Published month of posts (Without leading zeros) |
+| :day | Published day of posts (2-digit) |
+| :i_day | Published day of posts (Without leading zeros) |
+| :slug | Slugified file path (Without extension) |
+| :regular | Permalink generated by VuePress by default, for implementation see [here](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/shared-utils/src/fileToPath.ts) |
+
+[1]:https://en.wikipedia.org/wiki/Link_rot

packages/docs/docs/guide/using-vue.md

@@ -229,9 +229,9 @@ Specify a specific slot for a specific page (.md) for rendering. This will be us
 
 - **Props**:
 
-   - `text` - string
-   - `type` - string, optional value: `"tip"|"warn"|"error"`, defaults to `"tip"`.
-   - `vertical` - string, optional value: `"top"|"middle"`, defaults to `"top"`.
+  - `text` - string
+  - `type` - string, optional value: `"tip"|"warn"|"error"`, defaults to `"tip"`.
+  - `vertical` - string, optional value: `"top"|"middle"`, defaults to `"top"`.
 
 - **Usage**:
 

packages/docs/docs/plugin/life-cycle.md

@@ -39,7 +39,7 @@ module.exports = {
 - Type: `AsyncFunction`
 - Scope：`build`
 
- Called when a (production) build finishes, with an array of generated page HTML paths.
+  Called when a (production) build finishes, with an array of generated page HTML paths.
 
 ``` js
 module.exports = {

packages/docs/docs/plugin/official/plugin-back-to-top.md

@@ -18,6 +18,6 @@ yarn add -D @vuepress/plugin-back-to-top@next
 
 ```javascript
 module.exports = {
-  plugins: ['@vuepress/back-to-top'] 
+  plugins: ['@vuepress/back-to-top']
 }
 ```

packages/docs/docs/plugin/official/plugin-google-analytics.md

@@ -20,13 +20,13 @@ yarn add -D @vuepress/plugin-google-analytics@next
 ```javascript
 module.exports = {
   plugins: [
-    [ 
+    [
       '@vuepress/google-analytics',
       {
         'ga': '' // UA-00000000-0
       }
-    ]  
-  ] 
+    ]
+  ]
 }
 ```
 

packages/docs/docs/plugin/official/plugin-last-updated.md

@@ -15,7 +15,7 @@ If you use it at your custom theme, you'll need to handle the UI by yourself, an
 
 ```js
 module.exports = {
-  plugins: ['@vuepress/last-updated'] 
+  plugins: ['@vuepress/last-updated']
 }
 ```
 
@@ -35,7 +35,7 @@ const moment = require('moment');
 
 module.exports = {
   plugins: [
-    [ 
+    [
       '@vuepress/last-updated',
       {
         transformer: (timestamp, lang) => {

packages/docs/docs/plugin/official/plugin-nprogress.md

@@ -34,6 +34,6 @@ Set `$nprogressColor` in your __site__ or __theme__ `palette.styl` file to chang
 $nprogressColor = red
 ```
 
-**Also see:**
+__Also see:__
 
 - [Config Reference > Styling](../../config/README.md#styling)