Skip to content

A tool for compiling markdown files into standalone HTML documents, using Python Markdown. Supports Latex (given an existing Tex distribution), custom CSS and JavaScript, multiple document variations from a single source file, and a live output view.

License

Notifications You must be signed in to change notification settings

lamarkdown/lamarkdown

Repository files navigation

Lamarkdown

Lamarkdown is a command-line document preparation system based on Python-Markdown. It attempts to address similar use cases to LaTeX, but using the Markdown and HTML formats. It is not directly intended to build static websites, though its extensions can be reused in MkDocs (or in other applications based on Python-Markdown).

Take the Lamarkdown tour to get a first impression.

Requirements and Installation

Lamarkdown depends on Python 3.8+. To install via pip:

$ pip install lamarkdown

Basic Usage

To compile mydocument.md into mydocument.html, run:

$ lamd mydocument.md

To enable the live-update mode, use -l/--live:

$ lamd -l mydocument.md

This will launch a local web-server and a web-browser, and will keep mydocument.html in sync with any changes made to mydocument.md, until you press Ctrl+C in the terminal.

Full Documentation

See the full documentation at lamarkdown.github.io.

About

A tool for compiling markdown files into standalone HTML documents, using Python Markdown. Supports Latex (given an existing Tex distribution), custom CSS and JavaScript, multiple document variations from a single source file, and a live output view.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published