Skip to content

Commit a953dc6

Browse files
Konrad Jamrozikmarkcowl
authored andcommitted
Add info about SDK azure-sdk-for-* checks and SDK azure-powershell to ci-fix doc; Clean up markdownlint rules and ci-fix doc. (#29311)
1 parent 872e780 commit a953dc6

4 files changed

Lines changed: 262 additions & 169 deletions

File tree

.markdownlint.json

Lines changed: 0 additions & 27 deletions
This file was deleted.

.markdownlint.jsonc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"default": true,
3+
4+
// MD013 - Line length
5+
// https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
6+
//
7+
// "line_length" : 120:
8+
// Allow lines of length 120 instead of the default 80. Keep in sync with guide lines .vscode/settings.json.
9+
//
10+
// "tables": false
11+
// Do not include tables. Breaking a line in a table to meet the line length would add a line break in the table
12+
// itself. We do not want that.
13+
//
14+
// "headings": false
15+
// Do not include headings. One cannot break lines in headings, and we sometimes need long ones, e.g. for FAQs.
16+
"MD013": { "line_length" : 120, "tables": false, "headings": false },
17+
18+
// MD025 - Multiple top-level headings in the same document
19+
// https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md
20+
//
21+
// We sometimes prefer to have multiple top-level headings in the same document.
22+
"MD025": false,
23+
24+
// MD033 - No inline HTML
25+
// https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
26+
//
27+
// We allow inline HTML as sometimes we need <br/> within table cells.
28+
"MD033": false,
29+
30+
// MD034 - Bare URL used
31+
// https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md
32+
//
33+
// We allow bare URLs e.g. to link to GitHub issues.
34+
"MD034": false
35+
}

.vscode/settings.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,10 @@
3131
"[typespec]": {
3232
"editor.defaultFormatter": "typespec.typespec-vscode",
3333
"editor.formatOnSave": true
34-
}
34+
},
35+
"[markdown]": {
36+
"editor.rulers": [
37+
{ "column": 120, "color": "#ff0000c0" }
38+
]
39+
},
3540
}

0 commit comments

Comments
 (0)