セキュリティは安全ですか？

ローカル環境のみで動作し、外部への通信は一切行いません。パストラバーサル防止、CSPヘッダー、CORS制限（localhost限定）を実装しています。

Node.js CLI ドキュメントビューワー

ローカルドキュメントを、
ブラウザで美しく。

npx github:simota/docview <ディレクトリ> を実行するだけ。 Markdown・YAML・JSON・CSV・Mermaid図に対応したリッチビューワーが、ブラウザにすぐ開きます。

npx github:simota/docview .

Star on GitHub

インストール不要（npx）ライブリロード MIT License

DocView — ターミナルからコマンド実行し、ブラウザでMarkdownやMermaid図をリッチに表示

問題提起

こんな経験、ありませんか？

Markdownを確認するたびにGitHubにpush

ちょっとした確認のためだけにコミット＆プッシュ。作業が何度も中断される。

ローカルのドキュメント群をブラウザで見たい

エディタのプレビューは狭い。ファイルツリーやサイドバーがある本格的なビューワーが欲しい。

ファイル更新のたびに手動でリロード

ファイルを保存してからブラウザに切り替えてF5。この繰り返しが集中力を削ぐ。

CSV・YAML・ログも同じビューワーで確認したい

MarkdownはA、CSVはB、JSONはC、ログはD…ツールを使い分けるのが面倒。

ソリューション

ローカルのディレクトリを、
そのままブラウザに。

docviewは、ローカルの任意のディレクトリをそのままブラウザで表示するドキュメントビューワーです。コマンド1本で起動。ファイル保存で即リロード。すべてのファイルを一つの場所で。

コマンド1本で起動

保存即リロード (SSE)

10種以上のフォーマット対応

ダークモード内蔵

ライブデモ

30秒で起動できる

以下のコマンドをターミナルに貼り付けるだけ。Node.js 18以上がインストールされていれば、すぐに起動します。

~ $

npx: installed 1 package in 2.3s

Serving directory: ./docs

✓ DocView started → http://localhost:4000

✓ Opening browser...

Watching for changes

npx github:simota/docview ./docs

← 今すぐ試す

コアベネフィット

なぜ docview なのか

Live Reload

保存するたびに即反映。集中が切れない。

SSE（Server-Sent Events）によるライブリロードで、ファイルを保存した瞬間にブラウザが自動更新。エディタとブラウザの切り替えが不要になり、フローに入り込んだまま作業できます。

Zero Install

コマンド1本。30秒で起動できる。

npx github:simota/docview でインストールなしに即起動。グローバルインストール（npm i -g docview）にも対応しています。

Multi-format

あらゆるファイルを、一つの場所で。

Markdown（GFM、脚注、KaTeX、Mermaid、GitHub Alerts）、YAML、JSON、CSV、画像ファイルを統一されたビューワーで閲覧できます。ツールを切り替える必要がありません。

機能一覧

必要な機能が、全部ある。

開発者がドキュメントを快適に閲覧・編集するために必要な機能を内蔵しています。

.md .yaml .json .csv / .tsv .jsonl .log .toml / .ini .png / .jpg Mermaid KaTeX GFM

ライブリロード

SSEでファイル変更を即時反映

ダークモード

OS設定に連動 + localStorage保存

ファイルツリー

サイドバーに階層表示

タブ管理

複数ファイルをタブで同時表示

全文検索

ディレクトリ全体をgrep検索

vim風 Find Bar

正規表現対応のページ内検索

GitHub Alerts

[!NOTE] [!WARNING] 等を美しく表示

KaTeX / Mermaid

数式・フローチャートをレンダリング

Split View

2ファイルを左右に並べて表示

バックリンク

そのファイルへの参照元を表示

画像エクスポート

レンダリング結果をPNG保存

JSON/YAMLツリー

ネスト構造を折りたたみ表示

ログビューワー

Apache/nginxログをテーブル表示・ステータス色分け

大容量ファイル対応

数百MBのCSV/ログをチャンク読み込み・省メモリ表示

ファイル内検索

大容量ファイルもサーバーサイドgrepで高速フィルタ

使い方

3ステップで完了

Step 01

コマンドを実行

ターミナルを開いて1行打つだけ。グローバルインストール不要。

$ npx github:simota/docview ./docs

Step 02

ブラウザが自動起動

数秒でサーバーが起動し、ブラウザが自動で開きます。

→ http://localhost:4000

Step 03

ファイルを編集→即反映

ファイルを保存するたびに、ブラウザが自動リロード。

Save → Auto Reload ⚡

docview と他ツールの機能比較
機能	docview	VS Code Preview	grip
インストール不要（npx）	✓	— VSCode必要	— pip install
ライブリロード	✓ SSE	△ 手動	—
Mermaid / KaTeX	✓	△ 拡張要	—
YAML / JSON / CSV 対応	✓	—	—
全文検索	✓	△	—
Split View / タブ	✓	△	—
外部サービス不要	✓ 完全ローカル	✓	— GitHub API使用

よくある質問

FAQ

インストールなしで使えますか？

はい。npx github:simota/docview コマンドを実行するだけで、グローバルインストールなしに即座に起動できます。恒久的に使う場合は npm install -g github:simota/docview でグローバルインストールも可能です。

どのOSで動作しますか？

macOS、Windows、Linuxで動作します。Node.js 18以上がインストールされていれば、 OS固有の設定は不要です。

セキュリティは大丈夫ですか？

ローカル環境のみで動作し、外部サーバーへの通信は一切行いません。パストラバーサル防止（シンボリックリンクチェック）、CSPヘッダー、CORS制限（localhost限定）、 DOMPurifyによるHTMLサニタイズを実装しています。

必要なNode.jsのバージョンは？

Node.js 18以上が必要です。node --version で確認できます。 Node.jsは nodejs.org からダウンロードできます。

大きなファイルでも問題なく表示できますか？

はい。5MBを超えるCSV、TSV、JSONL、ログファイルは自動的にチャンクモードに切り替わり、 1000行ずつサーバーサイドでページネーション表示します。数百MBのファイルでもブラウザのメモリを圧迫しません。ファイル内検索もサーバーサイドで処理されるため、大容量ファイルでも高速にフィルタリングできます。

無料で使えますか？将来有料になりますか？

MIT Licenseのオープンソースソフトウェアです。永久に無料でご利用いただけます。商用利用も可能です。

ローカルドキュメントを、ブラウザで美しく。