okflint
=======

**okflint** is a compliance linter for OKF (Open Knowledge Format) documentary bases.
It verifies the structure of Markdown files — frontmatter, links, types — against a
YAML manifest declaring the base's conventions.

.. toctree::
   :maxdepth: 2
   :caption: Usage

   guides/quickstart
   guides/manifest
   guides/rules

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/scanner
   api/manifest
   api/audit
   api/validate
   api/cli

.. toctree::
   :maxdepth: 1
   :caption: Project

   Roadmap <https://github.com/mattdav/okflint/blob/main/docs/project/ROADMAP.md>