Metadata-Version: 2.4
Name: viewmd
Version: 0.1.2
Summary: Simple HTTP server for viewing Markdown files in your browser
Author: German Greiner
License: MIT
Project-URL: Homepage, https://github.com/driangle/viewmd
Keywords: markdown,viewer,http-server,cli
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: markdown>=3.0
Dynamic: license-file

# viewmd

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

## Installation

```bash
pipx install viewmd
```

## Quick Start

```bash
# 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

```bash
viewmd          # Starts on port 8000
viewmd 3000     # Custom port
```

## Upgrade

```bash
pipx upgrade viewmd
```

## Uninstallation

```bash
pipx uninstall viewmd
```
