Skip to main content

A secure Markdown server with GitHub-style rendering

Project description

darkdown

darkdown

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

Installation

git clone https://github.com/phx/darkdown
cd darkdown
python3 -m pip install -r requirements.txt

(Putting it on PyPi shortly, just give me some time and be patient.)

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)

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

darkdown-1.0.0.tar.gz (1.9 kB view details)

Uploaded Source

Built Distribution

darkdown-1.0.0-py3-none-any.whl (2.0 kB view details)

Uploaded Python 3

File details

Details for the file darkdown-1.0.0.tar.gz.

File metadata

  • Download URL: darkdown-1.0.0.tar.gz
  • Upload date:
  • Size: 1.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for darkdown-1.0.0.tar.gz
Algorithm Hash digest
SHA256 f52128a78868e64c618d0b3fac2c398e0106a9ae067a31881fb73f31e3cf55f3
MD5 d1ae4d2842e5c1e81b84e4cf3f25105b
BLAKE2b-256 42c3ef2ddebdfef91fd77ee403f2f1aca4beb41fe5cb76a08f3ff61c88e801dc

See more details on using hashes here.

File details

Details for the file darkdown-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: darkdown-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for darkdown-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ccafe7ff6bf532d5257023cff8ff203bae89d5ba52f20bcdc1b4971ff6268cb5
MD5 cbb60ec0769b39ed5e13fe09bff45c86
BLAKE2b-256 e89cace1faecdfa4fea6afc87fab8c0748733d7a894934e02054bded9e0a0139

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page