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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdv_live-0.1.4.tar.gz
  • Upload date:
  • Size: 26.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.4.tar.gz
Algorithm Hash digest
SHA256 d367185c5fb7a21aba9c3ff65bf272cd7b192184ec308e4b77064cf3ff2a0895
MD5 108a1189ece960a01c8f15e98669ceff
BLAKE2b-256 6e7220b5d0dbbb77a2360f5c67bb1ec26542baf7c885067ab9946fb0455bbc03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdv_live-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 27.4 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 269f9f45e9bebb05cd8215ddc7e2fc331d2dcb7f6ac96da47b7b4976f5f19e0c
MD5 44758328e4070b76f2d920e00511216e
BLAKE2b-256 fd35078478bb5094da93221f25986f62328ed0a74436065cc677696fae4b2595

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