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.2.tar.gz (5.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.2-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: viewmd-0.1.2.tar.gz
  • Upload date:
  • Size: 5.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.2.tar.gz
Algorithm Hash digest
SHA256 4b175cbf1e115eadf0281b8e7e444c480ae107725ce298f261fc9d15d2b905e9
MD5 802bad9e043f83120bace6ee60b4dce6
BLAKE2b-256 f8c6d22985f7c077891359561e9ef2fedd508c42d5222440a842e3cf9a9ee18d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: viewmd-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fdb6dfa5e61bdbc23ae0ac231293412f3846c52194a806ed6a568adc66d9d295
MD5 c4c70c45a1e6f6949ba15f2f53632c19
BLAKE2b-256 29f42be738980c573b177af92a30d0c07ca4d731cd71e98fb958e89671dea4e9

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