Full Features List

  • Add / Update / Delete any front matter fields

  • Preserves front matter element order via oyaml

  • Uses Jinja2 Templates for configuration and processing:

    • Use Jinja2 filters for complex processing

    • Incrementally process files with multiple templates (iteratively)

  • Allows for multiple passes per source file

  • Provides exception handling easier debugging

  • Examples for implementation:

    1. Basic usage

    2. Advanced mulit-pass processor

    3. Recursive directory walker that uses multi-threading to edit files

  • Extensive Documented

    • with Sphinx

    • hosted on Github: here

    • Remote references (via sphinx intersphinx) is enabled

    • Compatible with pydoc

    • Bonus documentation of the documentation system and theme used.

  • Documentation Boilerplate

    • The documentation can be easily extracted and used for other projects

  • MIT Licensed