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.3.tar.gz (26.4 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.3-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdv_live-0.1.3.tar.gz
  • Upload date:
  • Size: 26.4 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.3.tar.gz
Algorithm Hash digest
SHA256 70d2e61988b9505201a0cffa84f598ac9c5b17cdb7542534fb686b2a488e9b39
MD5 36f6e5ce2047fa45c6819ec08f6a84aa
BLAKE2b-256 3c19f414df963fa8fd9903fff480d02aa7561aa39823642f1040cdac8ddf5276

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdv_live-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b099a1e1ce8d3e6f8d35e487615ac8ca536f2dc0153a8d35a379e8b3fb7073e0
MD5 8507ed707b910df64f188a8f5a3bfda6
BLAKE2b-256 9ad7f383327057eb04572e654d7368d1c08a17f95542b4d6d9ef27155e491dd6

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