このプロジェクトについて

markdown-viewer(バイナリ名 `mdv`)は、単一バイナリとして配布されるローカルMarkdownビューア兼ファイルブラウザです。MarkdownファイルのあるディレクトリをローカルHTTPアドレスで配信し、2ペインのインターフェースを提供します。左側には展開可能で永続的なファイルツリー、右側にはレンダリングされたコンテンツが表示されます。 レンダリングはGitHub Flavored Markdownに対応し、GitHub風のスタイル、シンタックスハイライト付きコードブロック、同梱のMermaid図サポートを備えています。UIアセット(CSS、JavaScript、HTMLテンプレート)はすべてバイナリに埋め込まれているため、外部依存や別途のインストール手順は不要です。 セキュリティの既定設定には、ディレクトリトラバーサル対策とXSSに対するHTMLサニタイズが含まれます。シャットダウンはUIから、またはCtrl+Cで実行できます。 インストールは、リリースページから対象プラットフォーム用の `mdv` バイナリをダウンロードし、アーカイブを展開してバイナリをPATHに配置します。設定は `config.json` ファイルまたはコマンドラインフラグで行い、優先順位は次のとおりです(後のものが前のものを上書き)。組み込みの既定値、`$HOME/.config/mdv/config.json`、カレントワーキングディレクトリの `config.json`、`MDV_` 接頭辞の環境変数(例: `MDV_PORT=9000`)、最後にコマンドラインフラグ。参考として `config.json.example` が提供されています。 使用方法は、Markdownファイルを含む任意のディレクトリで `mdv` を実行し、ブラウザで `http://127.0.0.1:8080` を開きます。フラグには `-p, --port`(既定8080)、ブラウザを自動起動する `-o, --open`、配信するルートディレクトリを設定する `-d, --dir`(既定 `.`)、および `--version` があります。 ソースからのビルドにはGo 1.24以降が必要です。Makeターゲットには、現在のプラットフォーム向けの `build`、クロスコンパイル用の `build-all`、zipアーカイブを生成する `package`、`test`、`clean` があります。対象プラットフォームはlinux/amd64、linux/arm64、darwin/arm64、windows/amd64です。macOSビルドはarm64のみですが、Intel Macはソースからビルドできます。リポジトリにはCHANGELOG.mdと、サードパーティライセンスの帰属を記載したNOTICE.mdも含まれています。