Skip to main content

Zero-dependency Python static-site generator. Base layout + partials + Markdown content + YAML data + shortcodes. One file, stdlib only.

Project description

Zero-dependency Python static-site generator. Base layout + partials + Markdown content + YAML data + shortcodes. One file, stdlib only.

PyPI CI License: MIT

Install

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

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

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lintc-0.10.0.tar.gz (63.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lintc-0.10.0-py3-none-any.whl (46.0 kB view details)

Uploaded Python 3

File details

Details for the file lintc-0.10.0.tar.gz.

File metadata

  • Download URL: lintc-0.10.0.tar.gz
  • Upload date:
  • Size: 63.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lintc-0.10.0.tar.gz
Algorithm Hash digest
SHA256 b0ccfb60c8c2115fefdc9d506f3654349f72e2949e9dea43929f8b44948d8c66
MD5 9346b58fbf209499f4f00cf23163b8cd
BLAKE2b-256 b786e663dca5b46b7a95c9c28f09c9fa022802d59af6c956c245508c0b1e7d65

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintc-0.10.0.tar.gz:

Publisher: release.yml on lintuxt/lintc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lintc-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: lintc-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 46.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lintc-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 023182c07dde8d10ffb7abe6d94f676b7b9ba1fa97734b441849ff12e596c5dd
MD5 0e74a62134fdbaf9c474f42bc0717d31
BLAKE2b-256 fd920a9dd007125dd53c8e221690ea087c797af0e9e79e35fb697efa90564435

See more details on using hashes here.

Provenance

The following attestation bundles were made for lintc-0.10.0-py3-none-any.whl:

Publisher: release.yml on lintuxt/lintc

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page