ターミナルで Markdown ファイルを編集する際、エディタとブラウザを行き来する必要はありませんか?markln はこの作業をシンプルにします——ターミナル内で直接編集しながらリアルタイムプレビューが可能です。

プロジェクト概要

属性内容
GitHubxqtr/markln
Stars51
言語Python
特徴ターミナル内リアルタイムプレビュー、2ペインレイアウト、軽量
最終更新4日前

解決する問題

Markdown を書く標準的なワークフローは通常こうなります:

  1. エディタで内容を書く
  2. ファイルを保存する
  3. ブラウザに切り替えてレンダリング結果を確認
  4. 問題を見つけてエディタに戻って修正
  5. ステップ 2-4 を繰り返す

markln はこのループを1つのターミナルウィンドウ内で完結させます。左側で編集、右側でリアルタイムプレビュー。コマンドライン環境から離れる必要はありません。

主な機能

2ペインリアルタイムプレビュー 画面は左右2つに分かれています:左側が編集エリア、右側がレンダリング後のプレビュー。カーソルを移動してもプレビューは同期して更新され、遅延は感じられません。

純粋なターミナル環境 グラフィカルインターフェースに依存せず、SSH でリモートサーバーにログインしても使用可能。VPS、コンテナ、またはデスクトップ環境のない作業シーンに適しています。

軽量な依存関係 Python 標準ライブラリと一般的なターミナルツールをベースに構築されており、インストールは簡単。Node.js や複雑なビルドプロセスは不要です。

Vim風ショートカット 方向キーでのカーソル移動に加え、Vim スタイルのナビゲーションショートカット(h j k l)も提供し、指の移動距離を減らします。

クイックスタート

# リポジトリをクローン
git clone https://github.com/xqtr/markln.git
cd markln

# 依存関係をインストール
pip install markdown

# 編集を開始
python markln.py your-file.md

起動後、2ペインインターフェースが表示されます:

  • Tab キーでフォーカスを切り替え(編集エリア / プレビューエリア)
  • プレビューエリアでは方向キーでスクロール可能
  • Ctrl+S で保存、Ctrl+Q で終了

類似ツールとの比較

ツールStars特徴
Glow31k+読み取り専用レンダリング、編集不可
mdv3.8k読み取り専用ビューア、スタイル豊富
Tusk7編集可能、Textual ベース
markln51編集+リアルタイムプレビュー、2ペイン

Glow と mdv はレンダリング表示に特化しており、ターミナル内で直接内容を変更したい場合、markln は現時点で数少ない選択肢の一つです。Tusk は同様の機能を持ちますが Textual フレームワークを使用。markln の実装はより軽量です。

ユースケース

  • リモートサーバーでのドキュメント作成:SSH ログイン後に直接編集、グラフィカル環境の設定不要
  • クイックノート:ターミナルで手軽に数行書き、リアルタイムでフォーマットを確認
  • README の作成:コミット前にレンダリング効果を最終チェック
  • 低リソース環境:古いマシンやコンテナでも快適に動作

注意事項

  • 現在は初期開発段階(v0.1.x)であり、機能は比較的シンプルです
  • プレビューは Python の markdown ライブラリをベースにしており、すべての GitHub Flavored Markdown 拡張に対応していません
  • 大規模ファイル(数千行)のパフォーマンスは十分にテストされていません
  • GPL v3 ライセンス、商用プロジェクトではコンプライアンスに注意が必要です

まとめ

markln はターミナル Markdown ツールの空白を埋めるものです:コマンドライン内で直接編集しながらリアルタイムプレビュー。51 という Star 数はまだ十分に知られていないことを示していますが、SSH セッションやコンテナで頻繁にドキュメントを書く場合、この小さなツールがまさに痛みを解消してくれるかもしれません。

プロジェクトは活発に開発されており、4日前に更新がありました。この方向性に興味がある場合は、GitHub で Star を付けてサポートしてみてください。

属性内容
リポジトリhttps://github.com/xqtr/markln
ライセンスGNU General Public License v3.0
言語Python
メンテナ@xqtr