ターミナルで Markdown をプレビューできる leaf が便利
ターミナル上で Markdown ファイルをリッチにプレビューできる leaf というツールが便利だったので紹介します。
leaf とは
leaf は、ターミナル上で動く Markdown プレビューアです。
GUI のようなリッチな表示をターミナルの中で実現してくれます。
主な特徴:
- テーブル、リスト、引用、コードブロックなどの Markdown 要素をリッチに表示
- GitHub 拡張(アラート、タスクチェックボックス、テキストハイライト)に対応
- コードのシンタックスハイライト
- YAML frontmatter をテーブルとして表示
- LaTeX 数式、Mermaid ダイアグラムのレンダリング
- TOC サイドバー(アクティブセクション追跡付き)
- ファイル変更の監視と自動リロード
- ファイルピッカー(ファジー検索)
Rust 製で、GitHub Stars は 1.7k ほどです。
インストール
Homebrew でインストールできます。
brew install leaf-md
使い方
ファイルを表示する
Markdown ファイルを引数に渡すだけです。
leaf README.md
ファイル変更を監視する(--watch)
--watch オプションを付けると、ファイルの変更を監視して自動でリロードしてくれます。
エディタで編集しながらリアルタイムにプレビューを確認できます。
leaf --watch README.md
パイプで渡す
標準入力からも受け取れます。
echo '# Hello' | leaf
stdout に出力する(--inline)
TUI を起動せず、標準出力にレンダリング結果を出力するモードもあります。
leaf --inline README.md
主なキーバインド
TUI 内では以下のキー操作が使えます。
| キー | 操作 |
|---|---|
j / k
|
上下スクロール |
g / G
|
先頭 / 末尾に移動 |
/ → Enter |
検索 |
n / N
|
次 / 前の検索結果 |
t |
TOC サイドバーの表示切り替え |
Shift+L |
行番号の表示切り替え |
w |
ウォッチモードの切り替え |
? |
ヘルプ表示 |
まとめ
brew install leaf-md だけで使い始められるので、ターミナルで Markdown を確認したい場面があればぜひ試してみてください。
