https://github.com/lamarkdown/lamarkdown
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.
https://github.com/lamarkdown/lamarkdown
documentation markdown markdown-to-html
Last synced: 5 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/lamarkdown/lamarkdown
- Owner: lamarkdown
- License: mit
- Created: 2023-01-11T11:34:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T14:20:26.000Z (about 2 years ago)
- Last Synced: 2025-09-23T06:59:47.950Z (9 months ago)
- Topics: documentation, markdown, markdown-to-html
- Language: Python
- Homepage:
- Size: 1.97 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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:
```console
$ pip install lamarkdown
```
## Basic Usage
To compile `mydocument.md` into `mydocument.html`, run:
```console
$ lamd mydocument.md
```
To enable the live-update mode, use `-l`/`--live`:
```console
$ 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](https://lamarkdown.github.io).
[Lamarkdown tour]: https://lamarkdown.github.io/tour
[MkDocs]: https://www.mkdocs.org/
[Python-Markdown]: https://python-markdown.github.io