https://github.com/phx/darkdown

python http.server wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.
https://github.com/phx/darkdown

Last synced: about 2 months ago
JSON representation

python http.server wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.

• Host: GitHub
• URL: https://github.com/phx/darkdown
• Owner: phx
• Created: 2024-10-19T23:14:32.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-10-20T05:03:11.000Z (3 months ago)
• Last Synced: 2024-11-20T09:05:04.403Z (2 months ago)
• Language: Python
• Size: 358 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![darkdown](./logo.webp)

# darkdown

A Python 3 `http.server` wrapper that supports ssl, basic auth, markdown rendering, and styling support for directory listings and markdown files.

## Installation

```sh

python3 -m pip install darkdown

```

## Manual Installation

```sh

git clone https://github.com/phx/darkdown

cd darkdown

python3 -m pip install -r requirements.txt

```

## Usage

```

usage: darkdown [-h] [-p PORT] [-b ADDRESS] [--directory DIRECTORY] [-u USERNAME] [-P PASSWORD] [-c CERTFILE] [-k KEYFILE]

Secure Markdown HTTP server with GitHub-style rendering, authentication, and HTTPS support.

options:

  -h, --help            show this help message and exit

  -p PORT, --port PORT  Specify alternate port [default: 8000]

  -b ADDRESS, --bind ADDRESS

                        Specify alternate bind address [default: all interfaces]

  --directory DIRECTORY

                        Specify alternate directory [default: current directory]

  -u USERNAME, --user USERNAME

                        Set a username for basic authentication

  -P PASSWORD, --password PASSWORD

                        Set a password for basic authentication

  -c CERTFILE, --cert CERTFILE

                        Path to the SSL certificate file (for HTTPS)

  -k KEYFILE, --key KEYFILE

                        Path to the SSL key file (for HTTPS)

```