The website, docs and blog for Commit Check.
Docs · Rules · CLI · GitHub Action · GitHub App · MCP server
Source for commit-check.com: the landing page, the blog, and the documentation for every Commit Check project.
$ pip install -r docs/requirements.txt
$ mkdocs serveOr through nox, which manages the environment for you:
$ nox -s docs-liveThe site uses Sumi, the MkDocs NG theme. It needs no system libraries and fetches nothing at build time.
| Path | Contents |
|---|---|
docs/index.md |
Landing page. Renders through docs/overrides/landing.html. |
docs/getting-started/, docs/guides/ |
Tutorials and how-to guides. |
docs/rules.md, docs/configuration.md |
Reference. |
docs/blog/ |
Blog, published by Sumi. A post's file name, YYYY-MM-DD-slug.md, sets its URL. |
docs/overrides/, docs/stylesheets/, docs/assets/ |
Theme, styles, brand assets. |
scripts/mkdocs_hooks.py |
Redirect stubs for the URLs the old Sphinx site served. |
docs/rules.md and the options table in docs/configuration.md describe
behaviour that lives in the
commit-check repository. They
are checked against the installed package in CI rather than maintained by hand
alone, so a rule or option cannot change there without this site failing here.
Pushes to main build and publish to GitHub Pages. Pull requests get a Netlify
deploy preview, configured in netlify.toml. The custom domain is pinned by
docs/CNAME, which MkDocs copies to the site root on every build.
Questions and ideas go to Discussions, bugs and typos on the site to Issues. Released under the MIT License.