Metadata-Version: 2.4
Name: viewmd
Version: 0.1.0
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

### Option 1: Using pipx (Recommended)

[pipx](https://pypa.github.io/pipx/) installs CLI tools in isolated environments, preventing dependency conflicts:

```bash
# Install pipx if you don't have it
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install viewmd
pipx install .
```

### Option 2: Using pip

Install globally with pip:

```bash
pip install .
```

Or install in development mode (changes to source code take effect immediately):

```bash
pip install -e .
```

### Option 3: Direct symlink (Manual)

```bash
chmod +x viewmd.py
sudo ln -s "$(pwd)/viewmd.py" /usr/local/bin/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
```

## Uninstallation

```bash
# If installed with pipx
pipx uninstall viewmd

# If installed with pip
pip uninstall viewmd
```

## Publishing to PyPI (Optional)

To make viewmd installable via `pip install viewmd` for everyone:

```bash
# Install build tools
pip install build twine

# Build the package
python -m build

# Upload to PyPI (requires account at pypi.org)
python -m twine upload dist/*
```

That's it. Simple.
