Cuneiform

Turns a Markdown file into a single, self-contained HTML page with GitHub Markdown styling, a retractable sidebar Table of Contents, light/dark toggle and zero external dependencies.

Requirements

Only pandoc v3+ is required. It must be installed and available on the system's PATH.

On macOS, simply install it with Homebrew:

brew install pandoc

Usage

python3 cuneiform.py INPUT.md [-o OUTPUT.html] [-t "Title"]

If output is omitted, the HTML will be written to <INPUT>.html in the same folder as the input file.
If the title is omitted, the first heading in the Markdown file will be used.

Example

To see an example, run:

python cuneiform.py README.md && open README.html

or open this repo website in your browser.

License

This project is released as open source under the terms of the MIT License.