diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 000000000..cb76e21d5 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,23 @@ +line-length: false +single-title: false +no-inline-html: + allowed_elements: + - badge + - eslint-code-block + - sup + +# enforce consistency +code-block-style: + style: fenced +code-fence-style: + style: backtick +emphasis-style: + style: asterisk +heading-style: + style: atx +hr-style: + style: --- +strong-style: + style: asterisk +ul-style: + style: dash diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 000000000..3c3629e64 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1 @@ +node_modules diff --git a/docs/rules/README.md b/docs/rules/README.md index 3d4a9b2e3..6e879b2f6 100644 --- a/docs/rules/README.md +++ b/docs/rules/README.md @@ -12,7 +12,6 @@ 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: diff --git a/docs/rules/custom-event-name-casing.md b/docs/rules/custom-event-name-casing.md index ecc130fbe..a2c4d3644 100644 --- a/docs/rules/custom-event-name-casing.md +++ b/docs/rules/custom-event-name-casing.md @@ -163,6 +163,11 @@ export default { +## :couple: Related Rules + +- [vue/v-on-event-hyphenation](./v-on-event-hyphenation.md) +- [vue/prop-name-casing](./prop-name-casing.md) + ## :books: Further Reading - [Guide - Custom Events] @@ -171,11 +176,6 @@ export default { [Guide - Custom Events]: https://vuejs.org/guide/components/events.html [Guide (for v2) - Custom Events]: https://v2.vuejs.org/v2/guide/components-custom-events.html -## :couple: Related Rules - -- [vue/v-on-event-hyphenation](./v-on-event-hyphenation.md) -- [vue/prop-name-casing](./prop-name-casing.md) - ## :rocket: Version This rule was introduced in eslint-plugin-vue v7.0.0 diff --git a/docs/rules/html-closing-bracket-newline.md b/docs/rules/html-closing-bracket-newline.md index df3a8ac3c..ac6c505d8 100644 --- a/docs/rules/html-closing-bracket-newline.md +++ b/docs/rules/html-closing-bracket-newline.md @@ -66,11 +66,11 @@ This rule aims to warn the right angle brackets which are at the location other ``` - `singleline` ... the configuration for single-line elements. It's a single-line element if the element does not have attributes or the last attribute is on the same line as the opening bracket. - - `"never"` (default) ... disallow line breaks before the closing bracket. - - `"always"` ... require one line break before the closing bracket. + - `"never"` (default) ... disallow line breaks before the closing bracket. + - `"always"` ... require one line break before the closing bracket. - `multiline` ... the configuration for multiline elements. It's a multiline element if the last attribute is not on the same line of the opening bracket. - - `"never"` ... disallow line breaks before the closing bracket. - - `"always"` (default) ... require one line break before the closing bracket. + - `"never"` ... disallow line breaks before the closing bracket. + - `"always"` (default) ... require one line break before the closing bracket. Plus, you can use [`vue/html-indent`](./html-indent.md) rule to enforce indent-level of the closing brackets. diff --git a/docs/rules/html-closing-bracket-spacing.md b/docs/rules/html-closing-bracket-spacing.md index ee2a608d2..6bbbff216 100644 --- a/docs/rules/html-closing-bracket-spacing.md +++ b/docs/rules/html-closing-bracket-spacing.md @@ -55,14 +55,14 @@ This rule aims to enforce consistent spacing style before closing brackets `>` o ``` - `startTag` (`"always" | "never"`) ... Setting for the `>` of start tags (e.g. `