Skip to content

Markdown render

Markdown Engine (ME) is a markdown rendering engine that enhances HTML content generated by the default Rust crate.

Usage

Compile a local file to PDF:

scimon compile notes.md

The PDF is written next to the input, reusing its name (notes.pdf).

Custom output

Use -o / --output to choose the output file. The extension is normalized to .pdf automatically:

scimon compile notes.md -o build/notes.pdf

Remote files

You can compile a .md file straight from a URL:

scimon compile https://example.com/readme.md

When no --output is given, the file name is derived from the URL.

EPUB output

Give the output an .epub name to package the Markdown as an EPUB instead of a PDF:

scimon compile notes.md -o book.epub

The book title comes from the output file name; the author defaults to Scimon.