diff --git a/.markdownlint.yml b/.markdownlint.yml index cb76e21d5..b300725cc 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -5,6 +5,8 @@ no-inline-html: - badge - eslint-code-block - sup + - rules-table + - span # enforce consistency code-block-style: diff --git a/docs/.vuepress/components/rules-table.vue b/docs/.vuepress/components/rules-table.vue new file mode 100644 index 000000000..29d31c4c6 --- /dev/null +++ b/docs/.vuepress/components/rules-table.vue @@ -0,0 +1,90 @@ + + + + Highlight: + + + {{ kindMark }} + + + + + + + + + + + diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl index 48680bbf3..724c68247 100644 --- a/docs/.vuepress/styles/index.styl +++ b/docs/.vuepress/styles/index.styl @@ -18,3 +18,9 @@ } } } + +.theme-container.rule-list .theme-default-content + max-width: 1280px; + +.emoji + font-family: "Segoe UI Emoji", "Segoe UI Symbol", "Apple Color Emoji", "Noto Color Emoji", "Noto Emoji", sans-serif diff --git a/docs/rules/README.md b/docs/rules/README.md index 26ce0e59d..9a54292c9 100644 --- a/docs/rules/README.md +++ b/docs/rules/README.md @@ -1,5 +1,6 @@ --- sidebarDepth: 0 +pageClass: rule-list --- # Available rules @@ -12,282 +13,172 @@ sidebarDepth: 0 :bulb: Indicates that some problems reported by the rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions). ::: -## Base Rules (Enabling Correct ESLint Parsing) - -Enforce all the rules in this category, as well as all higher priority rules, with: - -```json -{ - "extends": "plugin:vue/base" -} -``` - -| Rule ID | Description | | -|:--------|:------------|:---| -| [vue/comment-directive](./comment-directive.md) | support comment-directives in `` | | -| [vue/jsx-uses-vars](./jsx-uses-vars.md) | prevent variables used in JSX to be marked as unused | | -| [vue/script-setup-uses-vars](./script-setup-uses-vars.md) | prevent `