Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.19 KB

Features.md

File metadata and controls

34 lines (21 loc) · 1.19 KB

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:

    #. Basic usage #. Advanced mulit-pass processor #. 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