markdownlint
DavidAnson/markdownlint: A Node.js style checker and lint tool for Markdown/CommonMark files.
CommonMarkやGitHub Flavored Markdownなどの大手のMarkdown方言を主に参照していて、2023年現在だと最も信用できるlinterだと思う。
(Markdownは割と最低限のsyntaxしか定義しておらず、標準化を目指したドキュメントもないので、上記のような標準化プロジェクトを頼るべきなのだと思う。)
tips
おれのかんがえたさいきょうの.markdownlint.jsonc
いわゆるドキュメントツールへの互換性を気にしないのであれば、MD025は積極的に true にしたいなあ
(Cosenseのコードブロックにjsonc拡張子対応してほしいな〜〜仕方なく".json"にした👀)
code:.markdownlint.json
{
// MD007/ul-indent - Unordered list indentation
// - cf. https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc#L37
"MD007": {
"indent": 4
},
// MD025/single-title/single-h1 - Multiple top-level headings in the same document
// - cf. https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc#L132
// - Markdown記法を採用しているドキュメントツールとの互換性を持たせるため
// - 多くのドキュメントツールではタイトルが別になっているケースが多い
// - 上記の仕様を持つ場合、multiple h1が許容されているケースがほぼ全てだと思われる
"MD025": false
}
参考
markdownlint/doc/Rules.md at main · DavidAnson/markdownlint
MD025 Error when using front_matter_title and h1 · Issue #377 · DavidAnson/markdownlint
jonschlinkert said "I strongly oppose this feature, ..." | Metadata in documents - Extensions - CommonMark Discussion
Standardized metadata layer? - CommonMark Discussion
#定義 #Tools #Markdown #Lint