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.5.tar.gz (26.6 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.5-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mdv_live-0.1.5.tar.gz
Algorithm Hash digest
SHA256 e19dd746a16d7914d17d6d1d33a5c1fa0ad3e36627f13b3c811739f1598ccbfc
MD5 47ccebf88dccf5406bdb92856fc888df
BLAKE2b-256 71a7934fe7674ec010e7f02f8edf1752357514ed5a740ab0bb1fa1f36629ed90

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mdv_live-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 35dad6de69419f90cb598d33648cdf40c031896084c2a6966afecdf7155602c5
MD5 9c391c6d6a7d6d50bc0a3fd8b8444721
BLAKE2b-256 cd811869f3460e81091237f3b239841f36ef360cdc8a80b6e2375d0ac40be42f

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