Markdown Viewer のロゴ

Markdown Viewer

**ライブプレビューを備えた、ローカルファーストの Markdown エディター／ビューアー** ブラウザー、Progressive Web App（PWA）、Docker、Neutralino デスクトップアプリケーションで Markdown を開き、編集、整理、レビュー、描画、エクスポートできます。必要に応じて共有や共同編集も利用できます。 [![ライセンス](https://img.shields.io/github/license/ThisIs-Developer/Markdown-Viewer?style=flat-square&color=red)](../LICENSE) [![最新リリース](https://img.shields.io/github/v/release/ThisIs-Developer/Markdown-Viewer?style=flat-square&color=FF6B00)](https://github.com/ThisIs-Developer/Markdown-Viewer/releases)

CodeWiki で Markdown Viewer を見る DeepWiki で Markdown Viewer を見る

[English](../README.md) · **日本語** · [한국어](README_ko.md) · [简体中文](README_zh.md) · [繁體中文](README_tw.md) [Web アプリを開く](https://markdownviewer.pages.dev/) · [ドキュメント（英語）](../wiki/Home.md) · [Issue を報告](https://github.com/ThisIs-Developer/Markdown-Viewer/issues) · [リリース](https://github.com/ThisIs-Developer/Markdown-Viewer/releases)
目次（クリックして展開） - [Markdown Viewer について](#markdown-viewer-について) - [主な機能](#主な機能) - [クイックスタート](#クイックスタート) - [ローカル処理とネットワーク処理](#ローカル処理とネットワーク処理) - [メディアの保存](#メディアの保存) - [主な制限](#主な制限) - [プライバシー上の重要事項](#プライバシー上の重要事項) - [ドキュメント](#ドキュメント) - [ショーケースプロジェクト](#ショーケースプロジェクト) - [開発の歩み](#開発の歩み) - [コントリビューター](#コントリビューター) - [コントリビューションとライセンス](#コントリビューションとライセンス)
## Markdown Viewer について Markdown Viewer は、開発者、ライター、学生、研究者など、`.md`／`.markdown` ファイルを扱うすべての人に向けたオープンソースのローカルファーストワークスペースです。単なるプレーンテキストにとどまりません。複数の文書を整理し、Markdown を変更せずにコメントや提案でレビューし、図表、地図、チャート、数式、3D モデル、音楽をひとつの集中できるワークスペースで描画できます。 文書を Share Snapshot リンクにしてすばやく共有したり、アクセス制御付きの Live Share でリアルタイム共同編集、ライブカーソル、コメント、提案を利用したりできます。通常の編集は端末上で行われます。アカウントは不要で、アプリケーションには広告、分析、テレメトリ、サブスクリプションがありません。

Markdown Viewer のアプリケーション画面

## 主な機能 - **ワークスペースと文書：** アプリによる文書数の上限なく、文書をネストしたフォルダーに整理できます。実際の上限は利用可能なストレージ容量です。最近使ったファイル、お気に入り、検索、タブ、一括操作、暗号化された Secret Workspace（秘密のワークスペース）に対応します。 - **バックアップと復元：** フォルダー構成を保持したワークスペース ZIP をエクスポートまたはインポートできます。Secret Workspace の暗号化済みファイルは任意で含められますが、ゴミ箱とデスクトップの履歴はバックアップに含まれません。 - **編集とレビュー：** エディター、分割表示、プレビューを切り替えられます。書式設定ツール、独自の元に戻す／やり直す、検索と置換、LTR／RTL、コメント、提案を利用できます。 - **Markdown 描画：** CommonMark 形式の基本構文、GitHub-Flavored Markdown（GFM）、表、タスクリスト、アラート、脚注、定義リスト、コードのシンタックスハイライト、サニタイズ済み HTML、MathJax に対応します。 - **ビジュアルコンテンツ：** Mermaid、PlantUML、Graphviz／DOT、D2、Vega-Lite、WaveDrom、Markmap、GeoJSON、TopoJSON、STL、ABC 記譜を描画できます。

図表挿入モジュール 図表の描画例 3D STL ビュー 全画面の 3D STL ビュー

- **インポートとエクスポート：** ローカルファイルや公開 GitHub コンテンツを開き、Markdown、単体 HTML、PNG、ブラウザー印刷／PDF 保存、従来のラスター PDF として出力できます。 - **任意の共有機能：** 「表示のみ」または「編集可能」の Share Snapshot（スナップショットの共有）を作成したり、ホスト／編集可能／表示のみの権限を持つ一時的な Live Share（ライブシェア）ルームを開始したりできます。

Live Share セッション

- **複数の提供形態：** ホスト済み Web アプリ、PWA、静的ホスティング、Docker、Cloudflare、Neutralino デスクトップアプリケーションを利用できます。 実装済みの動作と制限は、[機能リファレンス（英語）](../wiki/Features.md)を参照してください。 ## クイックスタート [ホスト済み Web アプリ](https://markdownviewer.pages.dev/)を利用するか、リポジトリをローカル HTTP サーバーで起動します。 ```bash git clone https://github.com/ThisIs-Developer/Markdown-Viewer.git cd Markdown-Viewer python -m http.server 8080 ``` `http://localhost:8080` を開きます。`file://` では Web Worker や Service Worker がブラウザーにブロックされる場合があります。 | 利用方法 | 詳細（英語） | | :--- | :--- | | PWA／静的 Web ホスティング | [インストール](../wiki/Installation.md) | | Docker | [Docker デプロイ](../wiki/Docker-Deployment.md) | | Cloudflare Pages／KV／Durable Objects | [設定](../wiki/Configuration.md) | | Neutralino デスクトップアプリケーション | [デスクトップアプリケーション](../wiki/Desktop-App.md) | ## ローカル処理とネットワーク処理 Markdown Viewer はローカルファーストですが、すべての機能がオフラインで動作するわけではありません。 | 操作 | 既定のデータ経路 | | :--- | :--- | | 編集、ローカルインポート、プレビュー、ワークスペースの自動保存、ほとんどのエクスポート | 端末上 | | Web ライブラリと未キャッシュのレンダラー依存関係 | Web／PWA 版から CDN へ接続 | | GitHub インポートと絵文字検索 | GitHub API／raw コンテンツ | | PlantUML、D2、Graphviz、Vega-Lite、WaveDrom、一部の図表プレビュー | 図表ソースを PlantUML、Kroki、mermaid.ink に送信する場合あり | | 同意後に挿入する画像、GIF、動画 | 公開リンク型の Cloudflare 一時メディアストレージ（90 日） | | 大きな Share Snapshot | Cloudflare KV（90 日） | | Live Share | Cloudflare Durable Object の WebSocket リレー | | 外部画像、メディア、リンク、地図タイル | 文書で指定された外部ホスト | Share Snapshot と Live Share の URL はベアラーリンクです。有効なリンクを入手した人は、そのリンクに含まれる権限を利用できます。Live Share はエンドツーエンド暗号化されていません。機密性の高い文書を扱う前に、[プライバシーとセキュリティ（英語）](../wiki/Privacy-and-Security.md)を確認してください。 ## メディアの保存 - AVIF、BMP、GIF（アニメーション GIF を含む）、JPEG、PNG、WebP、MP4、WebM、Ogg を挿入できます。 - 初回の同意後、メディアは Cloudflare の一時ストレージにアップロードされ、短いコンテンツアドレス型 HTTPS URL として挿入されます。 - URL を知っている人は誰でも、期限が切れるまでメディアを取得できます。 - 同一コンテンツを最後にアップロードしてから 90 日後に期限切れになります。 - Share Snapshot と Live Share は Markdown 内の URL を共有します。メディアの別コピーは作成しません。 ## 主な制限 - Markdown Viewer は文書数の上限を設けません。実際の上限はブラウザーのクォータまたはデスクトップのファイルシステム容量です。 - 1 件のローカル Markdown ファイルは 10 MB までです。 - GitHub インポーターが表示する Markdown ファイルは、リポジトリ／フォルダーごとに最大 30 件です。 - メディアの元ファイルは処理前で 25 MiB までです。保存上限は静止画 300 KiB、GIF 5 MiB、動画 10 MiB です。 - 保存型 Share Snapshot は最大 8,000,000 文字で、90 日後に期限切れになります。 - Live Share は最大 64 WebSocket 参加者、1 メッセージ 8 MB までです。 - STL はソース 2 MiB、描画ジオメトリ 300,000 頂点までです。 - ラスター PDF／PNG はブラウザーのメモリ、Canvas、CORS の制約を受けます。 ## プライバシー上の重要事項 - 通常の Web 文書は文書単位の IndexedDB レコードに保存され、デスクトップ文書は固定の `Documents/Markdown Viewer Vault` に保存されます。 - プライベートモードを有効にすると、そのセッションでの新しい文書状態の保存が停止します。既存の通常文書と Secret Workspace データは削除されません。 - **ワークスペースをリセット**すると、文書、フォルダー、設定、レビューデータ、Secret Workspace データ、履歴、ゴミ箱が完全に削除されます。 - **ストレージとバックアップ**では、フォルダー構成を保持した ZIP を作成またはインポートできます。インポートすると、確認後に現在のワークスペースが完全に置き換えられます。 - Live Share は Markdown／レビューデータをサーバー側に永続保存しません。ただし、役割別のベアラー権限値と作成時刻は Durable Object ストレージに保存され、アプリケーション側の有効期限／削除経路はありません。 - Share Snapshot の作成 API は削除トークンを返しますが、現在の UI はそのトークンを表示せず、期限前の削除操作も提供していません。 - アプリケーションコードには、アカウント、分析、テレメトリ、広告、トラッキングピクセル、アプリ固有 Cookie は実装されていません。外部サービスやホスティング事業者は通常のリクエストログを処理する場合があります。 > **バックアップ:** **ワークスペースをリセット**すると、すべてのローカルワークスペースデータが完全に削除されます。必要なデータがある場合は、先に **ストレージとバックアップ** から ZIP バックアップを作成してください。 ## ドキュメント 詳細ページは英語で管理されています。 | 目的 | ページ（英語） | | :--- | :--- | | 全機能と制限 | [Features](../wiki/Features.md) | | 日常の操作とショートカット | [Usage Guide](../wiki/Usage-Guide.md) | | Markdown／図表の構文 | [Markdown Reference](../wiki/Markdown-Reference.md) | | Share Snapshot | [Share Snapshot](../wiki/Share-Snapshot.md) | | Live Share | [Live Share](../wiki/Live-Share-Cloudflare.md) | | プライバシーとセキュリティ | [Privacy and Security](../wiki/Privacy-and-Security.md) | | インストールとデプロイ | [Installation](../wiki/Installation.md) | | トラブルシューティング | [Troubleshooting](../wiki/Troubleshooting.md)／[FAQ](../wiki/FAQ.md) | | コントリビューション | [Contributing](../wiki/Contributing.md) | | 多言語用語とローカライズ | [Localization and Terminology](../wiki/Localization.md) | ## ショーケースプロジェクト Markdown Viewer を活用した以下のコミュニティプロジェクトは、各開発者によって独立して保守されています。 - [**Markdown Desk**](https://github.com/jhrepo/markdown-desk)：Tauri で構築された macOS 向けネイティブラッパーです。ネイティブのファイルダイアログとファイルハンドラー、メニューバー連携、自動再読み込み、アプリ内更新を追加します。 ## 開発の歩み Markdown Viewer は、PC 上の小さな個人プロジェクトとして始まりました。好奇心を出発点に、失敗と修正を重ね、多くの配慮を込めて作られたシンプルな Markdown ビューアーです。初期バージョンは今も公開されており、プロジェクトの原点であり続けています。 詳しい歴史は [Development Journey（英語）](../wiki/Development-Journey.md)をご覧ください。 ## コントリビューター Markdown Viewer は、コミュニティからのコントリビューションによって成長しています。 Markdown Viewer のコントリビューター ## コントリビューションとライセンス Pull Request を作成する前に、[Contributing（英語）](../wiki/Contributing.md)を確認してください。再現可能な不具合や明確な機能提案は [Issue Tracker](https://github.com/ThisIs-Developer/Markdown-Viewer/issues) に報告できます。脆弱性の詳細は通常の Issue に投稿しないでください。 Markdown Viewer は [Apache License 2.0](../LICENSE) で提供されています。