markless は、ターミナル向けに設計された Markdown ビューアです。SSH 環境や GUI のないサーバーでドキュメントを読む際の課題を解決し、ターミナルから離れることなく、整形されたテキストや画像を含む Markdown ファイルを表示できます。

プロジェクト概要

属性内容
GitHubjvanderberg/markless
Stars100
言語Rust
特徴ターミナル画像レンダリング、Kitty/iTerm2 プロトコル対応
最終更新10日前

解決する課題

ターミナルで Markdown ドキュメントを読むことは、これまで快適な体験とは言えませんでした:

  • cat コマンドは生の Markdown 構文を出力するため、可読性が低い
  • mdvglow などの従来ツールは書式はレンダリングできるが、画像には対応していない
  • リモートサーバーではブラウザが使えず、スクリーンショット付き README の確認が面倒

markless の中核的な価値は、ターミナルが Markdown を「本当に理解」できるようにすることです。画像も含めて。

主要機能

画像レンダリング対応

markless は複数のターミナルグラフィックプロトコルをサポートします:

  • Kitty Graphics Protocol:現在最も成熟したターミナルグラフィック方式
  • iTerm2 Inline Images:macOS ユーザーに馴染みのあるプロトコル
  • Sixel:古くからあるターミナルグラフィック標準、互換性が高い

Kitty、iTerm2、WezTerm、Ghostty など、どのターミナルを使っていても、Markdown 内の画像を直接表示できます。

リアルタイムプレビュー

markless はファイル変更を監視し、Markdown の保存後に自動的に表示を更新します。デスクトップのリアルタイムプレビューエディタに近い執筆体験を提供します。

軽量・高速

Rust プロジェクトとして、markless の起動速度とレンダリング性能は優れています。大規模ドキュメント(数千行)でも快適に動作します。

シンプルな操作

  • j/k または方向キーでスクロール
  • q で終了
  • マウスホイール対応(対応ターミナルで)

クイックスタート

# crates.io からインストール
cargo install markless

# またはプリコンパイル済みバイナリを使用
# GitHub Releases からプラットフォームに合った実行ファイルをダウンロード

# Markdown ファイルを表示
markless README.md

# リアルタイムプレビューモード
markless --watch docs/guide.md

他のツールとの比較

ツールStars画像対応特徴
glow15k+美しいデザイン、テーマ対応
mdv3k+Python 製、拡張しやすい
mdcat2k+⚠️ 限定的機能豊富だが設定が複雑
markless100画像レンダリングに特化、シンプルで高速

markless のポジショニングは明確です。最も機能が豊富な Markdown ビューアを目指すのではなく、「ターミナルで画像付き Markdown を見る」という問題の最適解を目指しています。

ユースケース

リモートサーバーでのドキュメント閲覧

SSH でサーバーに接続した後、プロジェクトドキュメントやログの説明を確認する必要がある場合。markless を使えば、ファイルをローカルにダウンロードせずに完全な閲覧が可能です。

CLI ツールのドキュメントプレビュー

コマンドラインツールを開発している場合、markless でターミナル内で README のレンダリング効果をプレビューし、ドキュメントの書式が正しいか確認できます。

グラフィカルインターフェースがない環境

Docker コンテナ、WSL、クラウド開発マシン——ブラウザがない環境すべてが markless の活躍場所です。

使用上の注意

  • 画像レンダリングには、対応するグラフィックプロトコルをサポートするターミナルが必要です(Kitty、iTerm2、WezTerm など)
  • 非対応のターミナルでは、markless は純テキストモードに優雅に降格します
  • プロジェクトは現在初期段階(v0.1.x)にあり、API に変更がある可能性があります

まとめ

markless は、ターミナル Markdown ビューアの画像レンダリングにおける空白を埋める、小さく美しいツールです。100 の Star の背後には、実際の問題を解決する実用的なプロジェクトがあります。ターミナルで多くの時間を過ごすのであれば、試す価値があります。

属性内容
リポジトリhttps://github.com/jvanderberg/markless
ライセンスMIT
言語Rust
管理者@jvanderberg