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.

Usage

• Quick start
  • Installation
  • Auditing a base
  • Validation (CI gate)
• Manifest format
  • Structure
  • Sections
• Rules catalogue
  • Stages
  • Severities

API Reference

• scanner
  • Header
  • MarkdownLink
  • WikiLink
  • blank_code_spans()
  • build_file_index()
  • extract_headers()
  • extract_markdown_links()
  • extract_wikilinks()
  • parse_frontmatter()
• manifest
  • BaseConfig
  • HygieneConfig
  • Manifest
  • ManifestError
  • ProfileConfig
  • RootConfig
  • SplitConfig
  • TypeConfig
  • load_manifest()
• audit
  • FileReport
  • analyze_file()
  • compute_stats()
  • get_okf_status()
  • run_audit()
• validate
  • Diagnostic
  • ManifestError
  • run_validate()
• cli
  • build_parser()
  • main()

Project

• Roadmap