mdast-lint - Markdown記法チェッカー
MarkdownはHTMLを知らなくとも手軽に書ける記法ですが、見た目とHTMLとしての結果がリンクしていないのでレンダリングした結果、思っていたのと違ったということも少なくありません。 そこで使ってみたいのがmdast-lintです。記法上のミスやMarkdownで記述するためのより良い書き方が確認できるはずです。
mdast-lintの使い方
mdast-lintはnpmを使ってインストールができます。クライアントサイドのJavaScriptにも対応しているのでBowerでもインストールできます。
$ npm install -g mdast-lint
使い方としては -u で mdast-lint を指定し、ファイル名を指定します。
$ mdast -u mdast-lint oss.md
oss.md
3:99 warning Line must be at most 80 characters maximum-line-length
7:1 warning First heading level should be `1` first-heading-level
9:87 warning Line must be at most 80 characters maximum-line-length
27:143 warning Line must be at most 80 characters maximum-line-length
✖ 4 problems (0 errors, 4 warnings)
こんな感じで結果が返ってきます。文字の長さや見出しの付け方などを指摘してくれます。エラーも出ますので、そうした時には修正することで思っていた結果が得られやすくなるでしょう。
mdast-lintはnode/JavaScript製、MIT Licenseのオープンソース・ソフトウェアです。