Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2025-09-21 21:30:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update MD026/no-trailing-punctuation to handle empty punctuation paramater, escape for RegExp (fixes #205).

Browse source
This commit is contained in:
David Anson 2019-07-26 23:03:56 -07:00
parent d336a11665
commit 91b4fcd55f
6 changed files with 39 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/Rules.md
View file

@ -792,23 +792,24 @@ Aliases: no-trailing-punctuation
Parameters: punctuation (string; default ".,;:!?。，；：！？")
This rule is triggered on any heading that has a normal or full-width punctuation
character as the last character in the line:
This rule is triggered on any heading that has one of the specified normal or
full-width punctuation characters as the last character in the line:
```markdown
# This is a heading.
```
To fix this, remove any trailing punctuation:
To fix this, remove the trailing punctuation:
```markdown
# This is a heading
```
Note: The punctuation parameter can be used to specify what characters class
as punctuation at the end of the heading. For example, you can set it to
`".,;:!"` to allow headings with question marks in them, such as might be used
in an FAQ.
Note: The `punctuation` parameter can be used to specify what characters count
as punctuation at the end of a heading. For example, you can change it to
`".,;:!"` to allow headings that end with a question mark, such as in an FAQ.
Setting the `punctuation` parameter to `""` allows all characters - and is
equivalent to disabling the rule.
<a name="md027"></a>