bwplotka/mdox

これは何？

主な機能

• 01Markdownファイルをその場で整形し、一貫したGFM形式にします。
• 02CLIのヘルプ出力など、コマンドを実行してコードブロックの内容を自動生成します。
• 03設定可能なスキップルールとGitHubに対応した検証機能で、相対リンクと外部リンクをチェックします。
• 04複数ドメインまたは複数バージョンのWebサイト向けに、リンクを相対パスへ書き換えます。
• 05front matterやback matterの追加、ファイル移動などを行い、Markdownを静的サイトジェネレーター向けに変換します。

ユースケース

• CIでコマンドを実行し、リポジトリのREADMEにあるCLIヘルプや設定例を最新の状態に保つ。
• pull requestのチェック時に、ドキュメント内のリンク切れを検出する。
• Markdownをソースとして、バージョン別のプロジェクトドキュメントを静的Webサイトとして公開する。

クイックスタート

1. 1

   Goでmdox CLIをインストールする

2. 2

   mdox fmtでMarkdownファイルを整形する

   mdox fmt *.md

使う前に知っておきたいこと

• !READMEには明示的なgo installコマンドが記載されていないため、インストール手順はコマンド形式で示していません。
• !このプロジェクトのスター数は80と少ないため、コミュニティのサポートが限られる可能性があります。

収録されている特集

トピック

よくある質問

mdox とは？

GFM形式のMarkdown整形、コマンドによるコードスニペットの自動生成、リンクチェック、Markdownからの静的ドキュメントサイト構築に対応するGo製CLI。 mdoxは、プロジェクトのドキュメントを正確で一貫した状態に保つためのコマンドラインツールです。GitHub Flavored Markdownに沿ってMarkdownファイルをその場で整形できるほか、相対リンクと外部リンクを検証できます。特定のURLをスキップする設定や、GitHub APIを使ってGitHubのissueやpull requestへのリンクを確認する機能もあります。

mdox は無料で使えますか？ライセンスは？

mdox は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

mdox は今もメンテナンスされていますか？

活発にメンテナンス中。mdox の最終コミットは 2026年11月3日 です。

mdox は何に使えますか？

CIでコマンドを実行し、リポジトリのREADMEにあるCLIヘルプや設定例を最新の状態に保つ。 pull requestのチェック時に、ドキュメント内のリンク切れを検出する。 Markdownをソースとして、バージョン別のプロジェクトドキュメントを静的Webサイトとして公開する。

mdox のインストール方法は？

Goでmdox CLIをインストールする mdox fmtでMarkdownファイルを整形する: mdox fmt *.md

mdox はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/bwplotka/mdox