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.8.tar.gz (27.5 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.8-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdv_live-0.1.8.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for mdv_live-0.1.8.tar.gz
Algorithm Hash digest
SHA256 7f186f333f8e42964a4608a62efe0de26439cac240bd4823bb49d2043056835a
MD5 1a82b125099014e547af5ec3c4c6f929
BLAKE2b-256 dcd4ef0481886a0d567050dcb3b211e06a9284489a91b1fe84808e268b8163d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdv_live-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for mdv_live-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 762ca6adae15fb3dab809ba95ae5b2da5e041b2716c621abc3923d07386e3488
MD5 437f490ac7ae876963359383042f85c6
BLAKE2b-256 6c1197d6102335a39ed54d8250ef920d4204986810ed88059570d662c1b1d155

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