ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Markdownは柔軟な記法をサポートしています。なんとなく書いてもそれっぽく表示されます。しかし、会社などで何人もMarkdownを使うようになると一定の統一された基準が必要になるでしょう。

そこで使ってみたいのがmarkdownlint-cliです。MarkdownのLintツールかつCLIになります。

markdownlint-cliの使い方

インストールが終わったら後はmarkdownlintコマンドを実行するだけです。そうすると直すべきポイントがリストアップされます。

$ markdownlint README.md 
README.md: 210: MD007 Unordered list indentation
README.md: 92: MD009 Trailing spaces
README.md: 56: MD010 Hard tabs

実際に試すと多くの指摘が出てくるはずです。設定ファイルもサポートされているので、不要と思われる指摘は除外しておくのが良いでしょう。そうすることで自社のルールにあったLintが可能になります。

markdownlint-cliはnode/JavaScript製のオープンソース・ソフトウェア(MIT License)です。

igorshubovych/markdownlint-cli: MarkdownLint Command Line Interface

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2