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.6.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.6-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mdv_live-0.1.6.tar.gz
Algorithm Hash digest
SHA256 9520b1921f5f6ef5bcf4a393cb85f36116afc6066a91e6627f8bbd90c4c7a127
MD5 c7e375c30fc6a041eae76972a17e42d8
BLAKE2b-256 774493648064476fe6e9d21756b320fcc98a37d2d91e25e40100fd933671dc36

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mdv_live-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 005c1b030169cd808991ad1450b52c8a4b7de0c2e690b984a29ec1f2ec40cd38
MD5 386cee1e93029ebc60a9c61414ba5d59
BLAKE2b-256 954bfddb7e5d66c8ff60b185f40793b006632013dd18315059b3024c58a4d409

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