Python PyPI

lintc

A single-file Python static-site generator. Layouts, partials, Markdown content, YAML data, and shortcodes — all compiled by one stdlib-only Python file.

v0.10.0 Updated

Built for personal sites and small doc trees

Compile

Layouts, partials, Markdown

Layout inheritance with layout and partial tags. Markdown for posts, YAML for structured pages. The whole engine is one Python file.

Iterate

Dev server with live reload

lintc serve runs an HTTP server with SSE-based live reload. Edit a file, the browser updates — no plugin chain.

Validate

Pre-deploy check

lintc check validates internal links, asset references, and GitHub-repo parity — catching broken builds before they ship.

Install in one line

uv tool install lintc      # recommended — isolated, no env needed
pipx install lintc         # equivalent if you prefer pipx
pip install --user lintc   # also fine

Requires Python 3.9 or newer. No other dependencies.

Quickstart

Scaffold a site:

src/
├── content/
│   ├── pages/home.yaml       # structured pages
│   ├── blog/*.md             # Markdown posts with YAML front matter
│   └── products/*.yaml
├── layouts/
│   ├── _base.html            # the master layout
│   ├── home.html             # page layouts
│   └── partials/             # shared chrome (head, header, footer, components)
├── data/                     # site-wide data (site.yaml, nav.yaml, etc.) + optional lintc.yaml
└── static/                   # copied verbatim into dist/

Build it:

lintc build              # emits dist/
lintc serve              # dev server with live reload at http://127.0.0.1:8000/
lintc check              # post-emit validations + configurable plugins

CLI

lintc build [--root DIR] [--include-drafts]
lintc serve [--root DIR] [--host HOST] [--port PORT] [--no-reload] [--no-drafts]
lintc check [--root DIR]
lintc --version
lintc --help

build hides drafts by default — use --include-drafts to opt them in. serve shows drafts by default — use --no-drafts to hide them.

lintc check's validators are configurable via src/data/lintc.yaml — see the docs for the schema.

lintc also supports check-time plugins, enabled under check.plugins in the same lintc.yaml. Plugins run during lintc check and can mutate the working tree (review drift with git diff). Bundled check-time plugins:

  • remote-sync — mirrors external files (e.g. upstream READMEs) to local paths via a committed lockfile (src/data/lintc-sync.lock). Pair with body_source to keep page body content in sync with upstream automatically.
  • tag-sync — sets a content YAML's version: field from a repo's latest git tag, tracked in src/data/lintc-tag.lock.
  • terminal-mock — regenerates a product page's terminal.body_html block by capturing real CLI output under a PTY, converting ANSI to t-* <span> classes, and wrapping in static shell chrome. Tracks output in src/data/lintc-terminal.lock.

lintc also supports build-time plugins, declared under build.plugins in the same lintc.yaml. A plugin contributes a shortcode plus its own JS/CSS, which are emitted into dist/ (and the matching <link>/<script> tags injected) only on pages that actually use the shortcode. lintc bundles one: lintc-swiper, a zero-dependency inline image carousel authored with the {{< lintc-swiper >}} shortcode (add loop="true" to wrap from the last slide back to the first).

Why it exists

The reason lintc exists is that the static site for lintuxt.ai needed a compiler, and the existing Python options either required a dependency graph I didn't want (Pelican, MkDocs) or a runtime I didn't want (Hugo's Go binary, Eleventy's Node.js). The constraint was: one file, stdlib only, no installation ceremony beyond having Python on the box.

It turned out to fit a useful niche. Personal sites and small documentation trees don't need the kitchen sink — they need layouts, partials, Markdown, structured data, and a dev server. lintc does exactly that and nothing more. The whole compiler is one Python file you can read top-to-bottom in an hour, including tests.

The trade-off is real: lintc is not Hugo, not Eleventy, not Astro. There's no plugin ecosystem of templates, no theme marketplace, no first-class image optimization, no markdown extension marketplace. If you're building a 500-page documentation site for a SaaS product, this is the wrong tool. If you're building a personal site, a project page, or a small handful of docs and you want the build pipeline to fit in your head, lintc is the right shape.

It also doubles as a portfolio surface: every release of lintc is visible on its own engineering page on lintuxt.ai, embedded via lintc's own body_source field and the remote-sync plugin keeping the content in sync from this very README. The site you might be looking at is built by the thing you're reading about.

Documentation · License

Documentation

Full docs: docs/index.md. Changelog: docs/changelog.md.

License

MIT — see LICENSE.

Back to Engineering