Markdownの品質を向上させる
VS Code拡張機能
Markdown書式チェッカーは、リアルタイムでMarkdownファイルの書式をチェックし、
より読みやすく、標準的な記法を維持するのに役立ちます。
# 見出し
⚠️ | 列1 | 列2 |
|-----|-----|
| データ | データ |
# 見出し
| 列1 | 列2 |
|-----|-----|
| データ | データ |主な機能
リアルタイムチェック
ファイルの編集中に自動的にチェックを実行。問題のある箇所を即座に可視化します。
見出し後のテーブルチェック
見出し行の直後にテーブルを配置している場合に警告を表示。Markdown標準に準拠した記法をサポートします。
柔軟な設定
チェック機能のオン・オフや、報告する問題の最大数など、使いやすさに応じて設定をカスタマイズ可能。
インストール
1 VS Code Marketplaceから
最も簡単な方法です。VS Codeの拡張機能パネルから「Markdown Format Checker」を検索してインストールできます。
1. VS Codeを開く
2. 拡張機能パネル (Ctrl+Shift+X) を開く
3. "Markdown Format Checker"を検索
4. インストールボタンをクリック
2 コマンドラインから
VSIXファイルをダウンロードして、コマンドラインからインストールすることもできます。
code --install-extension markdown-format-checker-0.0.1.vsix
3 開発モードでテスト
開発に貢献したい方やカスタマイズしたい方は、リポジトリをクローンして開発モードで実行できます。
git clone https://github.com/SatoSakuya/markdown-format-checker.git
cd markdown-format-checker
npm install
# VS Codeで開き、F5キーを押す
使い方
Markdownファイルを開く
VS CodeでMarkdownファイル（.md）を開きます。
自動チェック
拡張機能が自動的にドキュメントをチェックします。問題がある場合、該当行に警告が表示されます。
手動チェック（オプション）
コマンドパレット（Ctrl+Shift+P）から「Check Markdown Format」を実行して手動チェックも可能です。
設定項目
markdownFormatChecker.enableTableAfterHeadingCheck
見出し後のテーブルチェックを有効にする（デフォルト: true）
markdownFormatChecker.maxNumberOfProblems
報告する問題の最大数（デフォルト: 100）
例
問題のある例
# 見出し
| 列1 | 列2 |
|-----|-----|
| データ | データ |見出しの直後にテーブルがあると、一部のMarkdownパーサーで正しく表示されません。
正しい例
# 見出し
| 列1 | 列2 |
|-----|-----|
| データ | データ |見出しとテーブルの間に空行を入れることで、すべてのMarkdownパーサーで正しく表示されます。