Skip to content
Prev Previous commit
Escape Markdown symbols in docs
matches Prettier formatting and may prevent undesired rendering in the future
  • Loading branch information
FloEdelmann committed Feb 13, 2024
commit 2f070441cfdb66ed13ea3b8caf00b94ad8905740
2 changes: 1 addition & 1 deletion docs/rules/no-template-target-blank.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ since: v7.0.0

# vue/no-template-target-blank

> disallow target="_blank" attribute without rel="noopener noreferrer"
> disallow target="\_blank" attribute without rel="noopener noreferrer"

- :bulb: Some problems reported by this rule are manually fixable by editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-import-from-vue.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ since: v8.5.0

# vue/prefer-import-from-vue

> enforce import from 'vue' instead of import from '@vue/*'
> enforce import from 'vue' instead of import from '@vue/\*'

- :gear: This rule is included in all of `"plugin:vue/vue3-essential"`, `"plugin:vue/vue3-strongly-recommended"` and `"plugin:vue/vue3-recommended"`.
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
Expand Down
5 changes: 4 additions & 1 deletion tools/update-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,10 @@ class DocFile {
const description = meta.docs
? meta.docs.description
: this.content.match(/^description: (.*)$/m)[1]
const title = `# ${ruleId}\n\n> ${description}`
const escapedDescription = description
.replace(/\*/g, '\\*')
.replace(/_/g, '\\_')
const title = `# ${ruleId}\n\n> ${escapedDescription}`
const notes = []

if (meta.removedInVersion) {
Expand Down