Skip to main content

Markdown Viewer - File tree + Live preview + Hot reload

Project description

MDV - Markdown Viewer

ファイルツリー + ライブプレビュー付きマークダウンビューア

Features

  • 📁 左側にフォルダツリー表示
  • 📄 マークダウンをHTMLでレンダリング
  • 🔄 ファイル更新時に自動リロード(WebSocket)
  • 🎨 シンタックスハイライト(highlight.js)
  • 📊 Mermaid図のレンダリング対応
  • 🌙 ダークテーマ

Installation

# PyPIからインストール(推奨)
pip install mdv-live

# または開発版をインストール
git clone https://github.com/panhouse/mdv.git
cd mdv
pip install -e .

Usage

# カレントディレクトリを表示
mdv

# 特定のディレクトリを表示
mdv ./project/

# 特定のファイルを開く
mdv README.md

# ポート指定
mdv -p 9000

# ブラウザを自動で開かない
mdv --no-browser

# MarkdownをPDFに変換
mdv --pdf README.md
mdv --pdf README.md -o output.pdf

# サーバー管理
mdv -l        # 稼働中のサーバー一覧
mdv -k -a     # 全サーバー停止
mdv -k <PID>  # 特定サーバー停止

Requirements

  • Python 3.9+
  • FastAPI
  • uvicorn
  • watchdog
  • markdown

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdv_live-0.1.9.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdv_live-0.1.9-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

Details for the file mdv_live-0.1.9.tar.gz.

File metadata

  • Download URL: mdv_live-0.1.9.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for mdv_live-0.1.9.tar.gz
Algorithm Hash digest
SHA256 4fc72e8653bf0f0e5c2256b87c8d2a327fcb3f7b375da697fe3be0fd0f3130d9
MD5 74f967a45e0d5fce8c60a894968b47eb
BLAKE2b-256 bed3cc1497664bc1319f1f02126bdc4541955c1e9239cf49f28d147937e042ea

See more details on using hashes here.

File details

Details for the file mdv_live-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: mdv_live-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for mdv_live-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4bea1e0dbc9fcb20075dc65b6a4b8b32a4e6572025a03578f421b520fb2ec3be
MD5 9fd6f91856b34c9ba726fbb0f1d807a3
BLAKE2b-256 6c6d1bc6cf947a323ef13b75a42919cb773728391d8a08aab877034ec8493c1c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page