Real-time Markdown preview tool with pandoc (view markdown)
npm install vimd🌐 English | 日本語
> 書きながら見る。Markdownプレビュー
---
---
GitHub (デフォルト)
Dark
Academic
Minimal
Technical
---
- Node.js >= 18.0.0
- pandoc >= 2.0（オプション、高品質ビルド時のみ）
``bash`
npm install -g vimd
現在のバージョン: v0.5.0
v0.2.0 からは pandoc なしで利用可能 になりました。
高品質な出力が必要な場合のみ pandoc をインストールしてください。
`bash`pandocのインストール（オプション）
brew install pandoc # macOS
sudo apt install pandoc # Ubuntu/Debian
choco install pandoc # Windows
`bashライブプレビューを開始（pandoc不要、高速）
vimd draft.md # 省略形式（v0.5.10以降）
vimd dev draft.md # 従来の形式も使用可能
---
バージョン情報
現在のバージョン: v0.5.0
v0.5.x はフォルダモード（複数ファイルプレビュー）を追加したバージョンです。
bash
npm install -g vimd
`---
コマンド
| コマンド | 説明 |
| ------------------- | ------------------------------ |
|
| ライブプレビューサーバーを起動（dev省略形） |
| vimd | フォルダモードを起動（dev省略形） |
| vimd dev | ライブプレビューサーバーを起動 |
| vimd dev | フォルダモードを起動 |
| vimd build | 静的HTMLを生成 |
| vimd theme | テーマを対話的に変更 |
| vimd config | 設定を対話的に編集 |
| vimd kill | 実行中のセッションを終了 |
| vimd reset | 設定をデフォルトにリセット |$3
`bash
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 # 確認なしでリセット
`---
設定
グローバル設定は
に保存されます。`javascript
export default {
theme: 'github',
port: 38080, // デフォルト: 38080（v0.2.1で変更）
open: true,
devParser: 'markdown-it', // dev用パーサー（デフォルト: markdown-it）
buildParser: 'pandoc', // build用パーサー（デフォルト: pandoc）
};
`$3
| パーサー | 特徴 | 用途 |
| ------------- | ---------------- | ------------------ |
|
| 高速、pandoc不要 | 開発時のプレビュー |
| pandoc | 高品質、多機能 | 最終出力の生成 |詳細な設定オプションは docs/ja/api.md を参照してください。
$3
vimd は MathJax を使用した TeX 数式表示に対応しています（v0.3.12以降）。
`markdown
インライン数式: $E = mc^2$ブロック数式:
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$
`bussproofs（証明図）にも対応しています:
markdown
$$
\begin{prooftree}
\AxiomC{$A$}
\AxiomC{$B$}
\BinaryInfC{$A \land B$}
\end{prooftree}
$$
`数式サポートの設定:
javascript
// ~/.vimd/config.js
export default {
math: {
enabled: true, // デフォルト: true
engine: 'mathjax', // 'mathjax' または 'katex'
},
};
`$3
vimd は
ファイルのプレビューに対応しています（v0.4.0以降）。`bash
LaTeX ファイルのライブプレビュー
vimd dev thesis.texLaTeX ファイルを HTML に変換
vimd build thesis.tex
`LaTeX ファイルは自動的に検出され、pandoc を使用して変換されます。
対応する拡張子:
-
- 注意: LaTeX プレビューには pandoc が必須です。pandoc がインストールされていない場合、インストールガイドが表示されます。
$3
vimd はフォルダ内の複数ファイルを同一ポートで切り替えながらプレビューできます（v0.5.0以降）。
bash
カレントディレクトリをプレビュー
vimd . # 省略形式（v0.5.10以降）
vimd dev . # 従来の形式も使用可能指定フォルダをプレビュー
vimd ./docs # 省略形式
vimd dev ./docs # 従来の形式
`サイドバーでファイルを選択し、リアルタイムでプレビューを確認できます。
対応する拡張子:
-
(Markdown)
- .tex, .latex (LaTeX)機能:
- ツリー形式のファイル表示（フォルダ展開/折りたたみ可能）
- サイドバーのリサイズ（ドラッグで幅変更）
- キーボードショートカット（Ctrl+B でサイドバー表示/非表示）
- ファイル変更時の自動リロード
---
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
フォルダモードのアイコンは vscode-icons を使用しています（CC BY-SA 4.0）。