/
.markdownlint.jsonc
112 lines (111 loc) · 5.29 KB
/
.markdownlint.jsonc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
{
// https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
// https://gist.github.com/Neos21/f97f85f3f2ebb2aaa3816c528afb4e8c
// MD001: 見出しレベルのインクリメントチェック
"header-increment": true,
// MD002: 最初に登場する見出しがレベル1でなくてもよい
"first-header-h1": false,
// MD003: 見出しのスタイル
"header-style": {
"style": "atx"
},
// MD004: リストの記号をハイフンにする
"ul-style": {
"style": "dash"
},
// MD005: リストのインデントを揃える
"list-indent": true,
// MD006: トップレベルのリストをインデントしない
"ul-start-left": true,
// MD007: リストのインデントに使用するスペースの数
"ul-indent": {
"indent": 2
},
// MD009: 改行のための2スペースを除いて、行末の不要なスペースを検知する
"no-trailing-spaces": {
"br_spaces": 2,
"strict": true // 段落替え時の不要な改行スペースを削除する
},
// MD010: Tab によるインデントを禁止する
"no-hard-tabs": true,
// MD011: リンク記法の誤りチェック
"no-reversed-links": true,
// MD012: 連続する空行を最大2つまでにする
"no-multiple-blanks": {
"maximum": 1
},
// MD013: 1行の長さを制御しない
"line-length": false,
// MD014: コードブロックにコマンドを書く際、行頭に「$」記号を強制しない
"commands-show-output": false,
// MD018: 見出しの「#」直後にスペースを入れること
"no-missing-space-atx": true,
// MD019: 見出しの「#」直後に複数のスペースを入れないこと
"no-multiple-space-atx": true,
// MD020: 見出しの「#」前後にスペースを入れること (Closed ATX スタイル向けのルールのため無意味)
"no-missing-space-closed-atx": true,
// MD021: 見出しの「#」前後に複数のスペースを入れないこと (Closed ATX スタイル向けのルールのため無意味)
"no-multiple-space-closed-atx": true,
// MD022: 見出しの前後に空行を入れること
"blanks-around-headers": true,
// MD023: 見出しにインデントを付けない
"header-start-left": true,
// MD024: 見出し文言の重複を許容する
"no-duplicate-header": false,
// MD025: 見出しレベル1は1ファイル中に1つのみにする
"single-h1": true,
// MD026: 見出しの文末に記載を禁止する記号 (句読点で終わらないこと)
"no-trailing-punctuation": {
"punctuation": ".,:!?、。"
},
// MD027: 引用記号「>」直後にスペースを1つだけ入れること
"no-multiple-space-blockquote": true,
// MD028: 引用ブロック中の空行を表現する際に引用記号「>」を書くこと
"no-blanks-blockquote": true,
// MD029: 順序付きリストは連番を明記する
"ol-prefix": {
"style": "ordered"
},
// MD030: リスト記号の直後にスペースを入れること
"list-marker-space": true,
// MD031: コードブロックの前後に空行を入れること (リスト中にコードブロックを記載する際は、リスト全体で MD031・MD032 を無効化するようコメントを入れておく)
"blanks-around-fences": true,
// MD032: リストの前後に空行を入れること
"blanks-around-lists": true,
// MD033: HTML の記述を許容しない
"no-inline-html": true,
// MD034: URL のベタ書きを禁止しない (リンク記法もしくはインラインコードとして表現する)
"no-bare-urls": false,
// MD035: 水平区切り線のスタイル
"hr-style": {
"style": "---"
},
// MD036: 強調構文を見出し風に使うことを許容しない
"no-emphasis-as-header": true,
// MD037: 強調構文の内側 (開始直後・終了直前) にスペースを書かないこと
"no-space-in-emphasis": true,
// MD038: インラインコードの内側 (開始直後・終了直前) にスペースを書かないこと
"no-space-in-code": true,
// MD039: リンクの内側 (開始直後・終了直前) にスペースを書かないこと
"no-space-in-links": true,
// MD040: コードブロックには言語を必ず記載する (言語指定が不要な場合は「text」を記載する)
"fenced-code-language": true,
// MD041: 1行目に見出しレベル1が記載されていなくても許容する (GitBook の extends 記法等が書かれるため無効化)
"first-line-h1": false,
// MD042: URL が空のリンク記法をチェックする
"no-empty-links": true,
// MD043: 特定の見出しレベル・見出し文言を強制する指定 (アウトラインの強制は不要なので無効化)
"required-headers": false,
// MD044: 英単語の大文字・小文字表記ゆれチェックを行う
"proper-names": true,
// MD045: 画像記法に Alt Text を書かなくてもよい
"no-alt-text": false,
// MD046: コードブロックスタイルの制限なし。fencedを期待するが mkdocs の !!! 記法が使えなくなるため無効化
"code-block-style": false,
// MD047: 改行文字で終了しなければならないか
"single-trailing-newline": true,
// MD048: コードフェンススタイルはバッククォートによるものとする
"code-fence-style": {
"style": "backtick"
}
}