地方エンジニアの学習日記

興味ある技術の雑なメモだったりを書いてくブログ。たまに日記とガジェット紹介。

MarkdownのLintツール

ドキュメントの整備なんかをする際に適当に突っ込んでおくだけでも良さそうなツール。

markdownのlintツール : markdownlint

github.com

markdown内のリンクが有効かどうかを確認するツール : markdown-link-check

github.com

GitHubActionsでやるならこんな感じnodeのセットアップアクションを書いておけば簡単に導入できる。

      - name: Install
        run: |
          sudo apt-get update
          pip install --user yamllint
          npm install markdownlint markdownlint-cli --save-dev
          npm install -g markdown-link-check

      - name: Lint Markdown
        run: |
          ./node_modules/.bin/markdownlint ./docs/test.md
          markdown-link-check ./docs/test.md