Flatmark 🔗

Flatmark turns a folder of Markdown, templates, and static assets into a static website. Code highlighting, math, and diagrams are rendered during the build, leaving deployable HTML, CSS, images, and other static files in _site/.

Start here 🔗

New to Flatmark? Follow the Quickstart to create and serve a small site.

Already working on a site? Choose the documentation that matches your task:

• Tutorials — learn Flatmark by building a site step by step.
• How-to guides — complete a specific authoring or configuration task.
• Reference — look up CLI options, configuration keys, file conventions, and template variables.
• Explanation — understand Flatmark's static-rendering model and its trade-offs.

What Flatmark provides 🔗

• CommonMark with tables, footnotes, task lists, and other authoring extensions
• build-time syntax highlighting, KaTeX, Mermaid, and Graphviz rendering
• Jinja layouts, includes, data files, pagination, and theme overrides
• multilingual routes with translation-aware template context
• generated search indexes
• a local server with file watching and live reload

Installation 🔗

On Debian or Ubuntu, download and install the .deb package:

curl -fL https://github.com/sake92/flatmark/releases/download/v0.2.0/flatmark_0.2.0_amd64.deb -o flatmark.deb
sudo apt install ./flatmark.deb

For macOS, other Linux distributions, and Windows, download the installer for your platform from the Flatmark releases page.

The first build may download the default theme and a compatible headless Chrome runtime.