Skip to content

Commit 43f535d

Browse files
MikeRatcliffeMikeRatcliffe
committed
build: Add markdownlint
1 parent c1230e4 commit 43f535d

7 files changed

Lines changed: 581 additions & 16 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
15+
1516
1. Go to '...'
1617
2. Click on '....'
1718
3. Scroll down to '....'
@@ -24,9 +25,10 @@ A clear and concise description of what you expected to happen.
2425
If applicable, add screenshots to help explain your problem.
2526

2627
**Desktop (please complete the following information):**
27-
- OS: [e.g. Windows/OSX/LINUX]
28-
- Running via binary or npm start
29-
- Version [e.g. v0.0.3-alpa]
28+
29+
- OS: [e.g. Windows/OSX/LINUX]
30+
- Running via binary or npm start
31+
- Version [e.g. v0.0.3-alpa]
3032

3133
**Additional context**
3234
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ assignees: whitewhidow
88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
A clear and concise description of what the problem is. Ex. I'm always
12+
frustrated when [...]
1213

1314
**Describe the solution you'd like**
1415
A clear and concise description of what you want to happen.
1516

1617
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
18+
A clear and concise description of any alternative solutions or features you've
19+
considered.
1820

1921
**Additional context**
2022
Add any other context or screenshots about the feature request here.

‎.markdownlint.jsonc‎

Lines changed: 292 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,292 @@
1+
{
2+
// Default state for all rules
3+
"default": true,
4+
5+
// Path to configuration file to extend
6+
"extends": null,
7+
8+
// MD001/heading-increment : Heading levels should only increment by one level at a time : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md001.md
9+
"MD001": true,
10+
11+
// MD003/heading-style : Heading style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md003.md
12+
"MD003": {
13+
// Heading style
14+
"style": "consistent",
15+
},
16+
17+
// MD004/ul-style : Unordered list style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md004.md
18+
"MD004": {
19+
// List style
20+
"style": "consistent",
21+
},
22+
23+
// MD005/list-indent : Inconsistent indentation for list items at the same level : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md005.md
24+
"MD005": true,
25+
26+
// MD007/ul-indent : Unordered list indentation : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md007.md
27+
"MD007": {
28+
// Spaces for indent
29+
"indent": 2,
30+
// Whether to indent the first level of the list
31+
"start_indented": false,
32+
// Spaces for first level indent (when start_indented is set)
33+
"start_indent": 2,
34+
},
35+
36+
// MD009/no-trailing-spaces : Trailing spaces : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
37+
"MD009": {
38+
// Spaces for line break
39+
"br_spaces": 2,
40+
// Allow spaces for empty lines in list items
41+
"list_item_empty_lines": false,
42+
// Include unnecessary breaks
43+
"strict": false,
44+
},
45+
46+
// MD010/no-hard-tabs : Hard tabs : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md010.md
47+
"MD010": {
48+
// Include code blocks
49+
"code_blocks": true,
50+
// Fenced code languages to ignore
51+
"ignore_code_languages": [],
52+
// Number of spaces for each hard tab
53+
"spaces_per_tab": 1,
54+
},
55+
56+
// MD011/no-reversed-links : Reversed link syntax : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md011.md
57+
"MD011": true,
58+
59+
// MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md012.md
60+
"MD012": {
61+
// Consecutive blank lines
62+
"maximum": 1,
63+
},
64+
65+
// MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
66+
"MD013": {
67+
// Number of characters
68+
"line_length": 80,
69+
// Number of characters for headings
70+
"heading_line_length": 80,
71+
// Number of characters for code blocks
72+
"code_block_line_length": 80,
73+
// Include code blocks
74+
"code_blocks": true,
75+
// Include tables
76+
"tables": false,
77+
// Include headings
78+
"headings": true,
79+
// Strict length checking
80+
"strict": false,
81+
// Stern length checking
82+
"stern": false,
83+
},
84+
85+
// MD014/commands-show-output : Dollar signs used before commands without showing output : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md014.md
86+
"MD014": true,
87+
88+
// MD018/no-missing-space-atx : No space after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md018.md
89+
"MD018": true,
90+
91+
// MD019/no-multiple-space-atx : Multiple spaces after hash on atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md019.md
92+
"MD019": true,
93+
94+
// MD020/no-missing-space-closed-atx : No space inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md020.md
95+
"MD020": true,
96+
97+
// MD021/no-multiple-space-closed-atx : Multiple spaces inside hashes on closed atx style heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md021.md
98+
"MD021": true,
99+
100+
// MD022/blanks-around-headings : Headings should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md022.md
101+
"MD022": {
102+
// Blank lines above heading
103+
"lines_above": 1,
104+
// Blank lines below heading
105+
"lines_below": 1,
106+
},
107+
108+
// MD023/heading-start-left : Headings must start at the beginning of the line : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md023.md
109+
"MD023": true,
110+
111+
// MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md024.md
112+
"MD024": {
113+
// Only check sibling headings
114+
"siblings_only": false,
115+
},
116+
117+
// MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md025.md
118+
"MD025": {
119+
// Heading level
120+
"level": 1,
121+
// RegExp for matching title in front matter
122+
"front_matter_title": "^\\s*title\\s*[:=]",
123+
},
124+
125+
// MD026/no-trailing-punctuation : Trailing punctuation in heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md026.md
126+
"MD026": false,
127+
128+
// MD027/no-multiple-space-blockquote : Multiple spaces after blockquote symbol : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md027.md
129+
"MD027": true,
130+
131+
// MD028/no-blanks-blockquote : Blank line inside blockquote : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md028.md
132+
"MD028": true,
133+
134+
// MD029/ol-prefix : Ordered list item prefix : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md029.md
135+
"MD029": {
136+
// List style
137+
"style": "one_or_ordered",
138+
},
139+
140+
// MD030/list-marker-space : Spaces after list markers : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md
141+
"MD030": {
142+
// Spaces for single-line unordered list items
143+
"ul_single": 1,
144+
// Spaces for single-line ordered list items
145+
"ol_single": 1,
146+
// Spaces for multi-line unordered list items
147+
"ul_multi": 1,
148+
// Spaces for multi-line ordered list items
149+
"ol_multi": 1,
150+
},
151+
152+
// MD031/blanks-around-fences : Fenced code blocks should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md031.md
153+
"MD031": {
154+
// Include list items
155+
"list_items": true,
156+
},
157+
158+
// MD032/blanks-around-lists : Lists should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md032.md
159+
"MD032": true,
160+
161+
// MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md033.md
162+
"MD033": false,
163+
164+
// MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md034.md
165+
"MD034": false,
166+
167+
// MD035/hr-style : Horizontal rule style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md035.md
168+
"MD035": {
169+
// Horizontal rule style
170+
"style": "consistent",
171+
},
172+
173+
// MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md036.md
174+
"MD036": {
175+
// Punctuation characters
176+
"punctuation": ".,;:!?。，；：！？",
177+
},
178+
179+
// MD037/no-space-in-emphasis : Spaces inside emphasis markers : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md037.md
180+
"MD037": true,
181+
182+
// MD038/no-space-in-code : Spaces inside code span elements : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md038.md
183+
"MD038": true,
184+
185+
// MD039/no-space-in-links : Spaces inside link text : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md039.md
186+
"MD039": true,
187+
188+
// MD040/fenced-code-language : Fenced code blocks should have a language specified : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md040.md
189+
"MD040": {
190+
// List of languages
191+
"allowed_languages": [],
192+
// Require language only
193+
"language_only": false,
194+
},
195+
196+
// MD041/first-line-heading/first-line-h1 : First line in a file should be a top-level heading : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md041.md
197+
"MD041": {
198+
// Heading level
199+
"level": 1,
200+
// RegExp for matching title in front matter
201+
"front_matter_title": "^\\s*title\\s*[:=]",
202+
},
203+
204+
// MD042/no-empty-links : No empty links : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md042.md
205+
"MD042": true,
206+
207+
// MD043/required-headings : Required heading structure : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md043.md
208+
"MD043": false,
209+
210+
// MD044/proper-names : Proper names should have the correct capitalization : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md044.md
211+
"MD044": {
212+
// List of proper names
213+
"names": [],
214+
// Include code blocks
215+
"code_blocks": true,
216+
// Include HTML elements
217+
"html_elements": true,
218+
},
219+
220+
// MD045/no-alt-text : Images should have alternate text (alt text) : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md045.md
221+
"MD045": true,
222+
223+
// MD046/code-block-style : Code block style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md046.md
224+
"MD046": {
225+
// Block style
226+
"style": "consistent",
227+
},
228+
229+
// MD047/single-trailing-newline : Files should end with a single newline character : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md047.md
230+
"MD047": true,
231+
232+
// MD048/code-fence-style : Code fence style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md048.md
233+
"MD048": {
234+
// Code fence style
235+
"style": "consistent",
236+
},
237+
238+
// MD049/emphasis-style : Emphasis style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md049.md
239+
"MD049": {
240+
// Emphasis style
241+
"style": "consistent",
242+
},
243+
244+
// MD050/strong-style : Strong style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md050.md
245+
"MD050": {
246+
// Strong style
247+
"style": "consistent",
248+
},
249+
250+
// MD051/link-fragments : Link fragments should be valid : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md051.md
251+
"MD051": true,
252+
253+
// MD052/reference-links-images : Reference links and images should use a label that is defined : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md052.md
254+
"MD052": {
255+
// Include shortcut syntax
256+
"shortcut_syntax": false,
257+
},
258+
259+
// MD053/link-image-reference-definitions : Link and image reference definitions should be needed : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md053.md
260+
"MD053": {
261+
// Ignored definitions
262+
"ignored_definitions": ["//"],
263+
},
264+
265+
// MD054/link-image-style : Link and image style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md054.md
266+
"MD054": {
267+
// Allow autolinks
268+
"autolink": true,
269+
// Allow inline links and images
270+
"inline": true,
271+
// Allow full reference links and images
272+
"full": true,
273+
// Allow collapsed reference links and images
274+
"collapsed": true,
275+
// Allow shortcut reference links and images
276+
"shortcut": true,
277+
// Allow URLs as inline links
278+
"url_inline": true,
279+
},
280+
281+
// MD055/table-pipe-style : Table pipe style : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md055.md
282+
"MD055": {
283+
// Table pipe style
284+
"style": "consistent",
285+
},
286+
287+
// MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md056.md
288+
"MD056": true,
289+
290+
// MD058/blanks-around-tables : Tables should be surrounded by blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md058.md
291+
"MD058": true,
292+
}

‎.markdownlintignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules/

0 commit comments

Comments
 (0)