vimd

🌐 English | 日本語

書きながら見る。Markdownプレビュー

---

デモ

---

テーマ

GitHub (デフォルト)

Dark

Academic

Minimal

Technical

---

クイックスタート

必要要件

• Node.js >= 18.0.0
• pandoc >= 2.0（オプション、高品質ビルド時のみ）

インストール

npm install -g [email protected]

現在の安定版: v0.2.4

v0.2.0 からは pandoc なしで利用可能 になりました。 高品質な出力が必要な場合のみ pandoc をインストールしてください。

# pandocのインストール（オプション）
brew install pandoc        # macOS
sudo apt install pandoc    # Ubuntu/Debian
choco install pandoc       # Windows

使い方

# ライブプレビューを開始（pandoc不要、高速）
vimd dev draft.md

# 静的HTMLを生成（pandoc使用、高品質）
vimd build draft.md

# 高速ビルド（pandoc不要）
vimd build draft.md --fast

# テーマを変更
vimd theme

# 設定を編集
vimd config

---

バージョン情報

安定版: v0.2.4

v0.3.x は内部アーキテクチャを刷新した実験的バージョンです。 安定した動作を求める場合は v0.2.4 をご利用ください。

安定版のインストール:

npm install -g [email protected]

最新版（実験的）のインストール:

npm install -g vimd@latest

---

コマンド

コマンド	説明
vimd dev <file>	ライブプレビューサーバーを起動
vimd build <file>	静的HTMLを生成
vimd theme	テーマを対話的に変更
vimd config	設定を対話的に編集
vimd kill	実行中のセッションを終了
vimd reset	設定をデフォルトにリセット

オプション

# dev コマンド
vimd dev draft.md --port 3000      # ポート指定
vimd dev draft.md --theme dark     # テーマ指定
vimd dev draft.md --no-open        # ブラウザを開かない
vimd dev draft.md --pandoc         # pandocパーサーを使用

# build コマンド
vimd build draft.md -o output.html # 出力先指定
vimd build draft.md --fast         # markdown-itで高速ビルド
vimd build draft.md --theme dark   # テーマ指定

# kill コマンド
vimd kill                          # 全セッションを終了
vimd kill --port 38080             # 特定ポートのセッションを終了

# reset コマンド
vimd reset                         # 設定をリセット（確認あり）
vimd reset --yes                   # 確認なしでリセット

---

設定

グローバル設定は ~/.vimd/config.js に保存されます。

export default {
  theme: 'github',
  port: 38080,  // デフォルト: 38080（v0.2.1で変更）
  open: true,
  devParser: 'markdown-it',  // dev用パーサー（デフォルト: markdown-it）
  buildParser: 'pandoc',     // build用パーサー（デフォルト: pandoc）
};

パーサー設定

パーサー	特徴	用途
markdown-it	高速、pandoc不要	開発時のプレビュー
pandoc	高品質、多機能	最終出力の生成

詳細な設定オプションは docs/ja/api.md を参照してください。

---

Why vimd?

特徴	vimd	他のツール
セットアップ	npm i -g vimd	複雑な設定が必要な場合も
外部依存	なし（pandocはオプション）	pandoc必須が多い
変換品質	markdown-it / pandoc 選択可	固定
テーマ	5種類組み込み	別途設定が必要
設定ファイル	プロジェクト外 (~/.vimd/)	プロジェクト内が多い
ライブリロード	自動	手動リロードが必要な場合も

---

ドキュメント

• 開発ガイド - 開発環境構築
• アーキテクチャ - プロジェクト構造
• APIリファレンス - 詳細なオプション
• テスト - テスト構成
• トラブルシューティング - よくある問題
• v0.3.0 リリースノート - WebSocket Direct Communication
• v0.2.0 リリースノート - Dual Parser System

---

リンク

• CONTRIBUTING.md - コントリビューションガイド
• CHANGELOG.md - 変更履歴
• GitHub
• npm

---

ライセンス

MIT © notokeishou