Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-03-03 09:00:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Strike through deprecated rule headings

Browse source 
Changes:
- Formats the headings of deprecated rules using strikethrough in the 'Rules /
Aliases' section of the 'README.md' file and in the 'doc/Rules.md' file.
- Updates the 'readme' and 'doc' tests in the 'test/markdownlint-test.js' file
to permit their respective rule headings to be formatted using strikethrough.

Benefits:
- Indicates rule deprecation status 'at a glance'.

(fixes #203)
This commit is contained in:
Travis C. LaGrone 2019-07-06 04:24:25 -05:00
parent 1ae512be69
commit f3e332eb00
3 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/Rules.md
View file

@ -3,7 +3,8 @@
This document contains a description of all rules, what they are checking for,
as well as an examples of documents that break the rule and corrected
versions of the examples.
versions of the examples. Any rule whose heading is ~~struck through~~ is
deprecated, but still provided for backward-compatibility.
<a name="md001"></a>
@ -43,7 +44,7 @@ level at a time:
<a name="md002"></a>
## MD002 - First heading should be a top level heading
## ~~MD002 - First heading should be a top level heading~~
Tags: headings, headers