Skip to content

Latest commit

 

History

History
196 lines (141 loc) · 15 KB

File metadata and controls

196 lines (141 loc) · 15 KB
Markdown Viewer のロゴ

Markdown Viewer

ライブプレビューを備えた、ローカルファーストの Markdown エディター/ビューアー

ブラウザー、Progressive Web App(PWA)、Docker、Neutralino デスクトップアプリケーションで Markdown を開き、編集、整理、レビュー、描画、エクスポートできます。必要に応じて共有や共同編集も利用できます。

ライセンス 最新リリース

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

English · 日本語 · 한국어 · 简体中文 · 繁體中文

Web アプリを開く · ドキュメント(英語) · Issue を報告 · リリース

目次(クリックして展開)

Markdown Viewer について

Markdown Viewer は、開発者、ライター、学生、研究者など、.md.markdown ファイルを扱うすべての人に向けたオープンソースのローカルファーストワークスペースです。単なるプレーンテキストにとどまりません。複数の文書を整理し、Markdown を変更せずにコメントや提案でレビューし、図表、地図、チャート、数式、3D モデル、音楽をひとつの集中できるワークスペースで描画できます。

文書を Share Snapshot リンクにしてすばやく共有したり、アクセス制御付きの Live Share でリアルタイム共同編集、ライブカーソル、コメント、提案を利用したりできます。通常の編集は端末上で行われます。アカウントは不要で、アプリケーションには広告、分析、テレメトリ、サブスクリプションがありません。

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

主な機能

  • ワークスペースと文書: Web では文書ごとの IndexedDB ストレージを使用し、文書をネストしたフォルダーに整理できます。最近使ったファイル、お気に入り、検索、タブ、一括操作、暗号化された 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 ビュー

  • インポートとエクスポート: ローカルファイルのほか、ブランチ、タグ、コミット SHA、必要に応じて非公開リポジトリの GitHub コンテンツを開けます。Markdown、単体 HTML、PNG、ブラウザー印刷/PDF 保存、従来のラスター PDF として出力できます。
  • 任意の共有機能: 「表示のみ」または「編集可能」の Share Snapshot(スナップショットの共有)を作成したり、ホスト/編集可能/表示のみの権限を持つ一時的な Live Share(ライブシェア)ルームを開始したりできます。

Live Share セッション

  • 複数の提供形態: ホスト済み Web アプリ、PWA、静的ホスティング、Docker、Cloudflare、Neutralino デスクトップアプリケーションを利用できます。

実装済みの動作と制限は、機能リファレンス(英語)を参照してください。

クイックスタート

ホスト済み Web アプリを利用するか、リポジトリをローカル HTTP サーバーで起動します。

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 ホスティング インストール
Docker Docker デプロイ
Cloudflare Pages/KV/Durable Objects 設定
Neutralino デスクトップアプリケーション デスクトップアプリケーション

ローカル処理とネットワーク処理

Markdown Viewer はローカルファーストですが、すべての機能がオフラインで動作するわけではありません。

操作 既定のデータ経路
編集、ローカルインポート、プレビュー、ワークスペースの自動保存、ほとんどのエクスポート 端末上
Web ライブラリと未キャッシュのレンダラー依存関係 Web/PWA 版から CDN へ接続
GitHub インポートと絵文字検索 公開コンテンツは GitHub API/raw コンテンツホスト、非公開コンテンツと PAT は api.github.com のみ
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 はエンドツーエンド暗号化されていません。機密性の高い文書を扱う前に、プライバシーとセキュリティ(英語)を確認してください。

ビジュアルレンダラーの概要

フェンス 描画方法
mermaid クライアント側。挿入プレビューでは mermaid.ink または Kroki を使用する場合あり
plantuml PlantUML サーバー。Kroki にフォールバック
d2graphvizdotvega-litevegalitewavedrom Kroki
markmap クライアント側の Markmap と D3
geojsontopojson クライアント側の Leaflet。地図タイルはネットワークを使用する場合あり
stl クライアント側の Three.js/WebGL
abc クライアント側の ABCJS。再生にはブラウザーの音声サポートが必要
math と LaTeX 区切り文字 クライアント側の MathJax

リモートレンダラーサービスは、描画対象の図表ソースを受信します。設定されたサービスを信頼できない場合は、機密性の高い図表ソースを送信しないでください。構文は Markdown Reference(英語)、制限は機能リファレンス(英語)を参照してください。

ドキュメント

詳細ページは英語で管理されています。

目的 ページ(英語)
最初に読むページを選ぶ Documentation Home
全機能と制限 Features
日常の操作とショートカット Usage Guide
Markdown/図表の構文 Markdown Reference
Share Snapshot Share Snapshot
Live Share Live Share
プライバシーとセキュリティ Privacy and Security
インストールとデプロイ Installation
ストレージ、レンダラー、Cloudflare の設定 Configuration
トラブルシューティング TroubleshootingFAQ
コントリビューション Contributing
多言語用語とローカライズ Localization and Terminology

主な制限

  • ワークスペースのバックアップインポートではワークスペースを統合できません。確認後、現在のワークスペースが完全に置き換えられます。
  • ワークスペースのバックアップには、ゴミ箱、デスクトップの履歴、クラッシュ復旧ジャーナルは含まれません。
  • 10 MB を超えるローカル Markdown ファイルは拒否されます。
  • GitHub 認証情報保管領域には、名前付き PAT を最大 50 件保存できます。各トークン名は 60 文字までです。
  • メディアの元ファイルは処理前で 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 頂点までです。
  • デスクトップの保管領域では、文書ごとに直近 20 件の履歴コピーが保持されます。
  • ラスター PDF/PNG はブラウザーのメモリ、Canvas、CORS の制約を受けます。

詳細は Features: Known Technical Limits(英語)を参照してください。

ショーケースプロジェクト

Markdown Viewer を活用した以下のコミュニティプロジェクトは、各開発者によって独立して保守されています。

  • Markdown Desk:Tauri で構築された macOS 向けネイティブラッパーです。ネイティブのファイルダイアログとファイルハンドラー、メニューバー連携、自動再読み込み、アプリ内更新を追加します。

開発の歩み

Markdown Viewer は、PC 上の小さな個人プロジェクトとして始まりました。好奇心を出発点に、失敗と修正を重ね、多くの配慮を込めて作られたシンプルな Markdown ビューアーです。初期バージョンは今も公開されており、プロジェクトの原点であり続けています。

詳しい歴史は Development Journey(英語)をご覧ください。

コントリビューター

Markdown Viewer は、コミュニティからのコントリビューションによって成長しています。

Markdown Viewer のコントリビューター

コントリビューションとサポート

Pull Request を作成する前に、Contributing(英語)を確認してください。再現可能な不具合や明確な機能提案は Issue Tracker に報告できます。

脆弱性の詳細は通常の Issue に投稿しないでください。Contributing: Security Reports(英語)に記載されている、リポジトリの非公開セキュリティ報告手段を利用してください。

ライセンス

Markdown Viewer は Apache License 2.0 で提供されています。