Skip to main content

Simple HTTP server for viewing Markdown files in your browser

Project description

viewmd

A simple HTTP server for viewing Markdown files in your browser.

Installation

pipx install viewmd

Quick Start

# Run from any directory
viewmd

# Open http://localhost:8000

What It Does

  • Markdown files (.md) - Rendered as HTML with nice styling
  • Text files (.py, .json, .gitignore, etc.) - Displayed in browser
  • Directories - Shows file listing, auto-displays README.md
  • Other files - Served normally (images, PDFs, etc.)

Usage

viewmd          # Starts on port 8000
viewmd 3000     # Custom port

Upgrade

pipx upgrade viewmd

Uninstallation

pipx uninstall viewmd

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

viewmd-0.1.3.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

viewmd-0.1.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: viewmd-0.1.3.tar.gz
  • Upload date:
  • Size: 7.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for viewmd-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e6f7762594928a26c003b68b44d8dfba194c4599a870ca6e635de5d15ebeb79b
MD5 a56ddb3b97f9d27fd08fe9483e7cf4b5
BLAKE2b-256 c688690403fe16fcd2ce9d4bbf64948b5f4506345f691205b619fd154e487109

See more details on using hashes here.

File details

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

File metadata

  • Download URL: viewmd-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for viewmd-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5354feee9a7ee003c05c94f0f5bc8f227e66e38eed7e468e0f545954bc199aeb
MD5 f4e47aa71d6ae1cddd6d5708eb0b658d
BLAKE2b-256 209ba2093468853a96fdbcf919960afc898aac4ee20672662e35cc8e0041a54b

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