mkdocs-macros-plugin

Delete install_package() function from codebase

Define explicitely python in update_pypi.sh

1.3.7, 2024-10-18

• Fixed: incompatibility with the d2 module (#249)

1.3.6, 2024-10-17

• Added: complete test framework, using pytest and Mkdocs-Test (#244) A number of automated test cases are implemented.
• Changed: move from setup.py to pyproject.toml (#250)

1.2.0, 2024-09-15

• Added: three hooks register_variables/macros/filters to facilitate cooperation with other MkDocs plugins.
• Fixed: `define_env() was always required in module (#191)
• Added: trace the case when no module is found (INFO)
• Improved documentation, particularly about HTML pages
• Added: parameters j2_comment_start_string and j2_comment_end_string to plugin's parameters, to specify alternate markers for comments.
• Added the multiline parameter force_render_paths in the config file, to specify directories or file patterns to be rendered for the case when render_by_default = false (the render_macros parameter in the YAML header of the page has the last word).

1.0.5, 2023-10-31

• Added: git.short_tag (#183)
• Added: Mermaid diagrams in the documentation (Readthedocs)
• Fixed: Changelog was no longer displayed (#186)

• change update_pypi.sh accordingly

Bump version number, for distribution (should solve #247)

Migrate all tests toward the mkdocs-test framework (#244)

Document hooks for #237 (register macros/variables/filters)

• Added: git.short_tag (#183)
• Added: Mermaid diagrams in the documentation (Readthedocs)
• Fixed: Changelog was no longer displayed (#186)

1.0.4, 2023-08-07

• Fixed: Warning due to filter issue with mkdocs >= 1.5
• Fixed: Debug html tables (including for macro_info()) are now readable also in dark mode.

1.0.2, 2023-07-02

• Added: it is now possible to use macros in page titles, in the nav section of the yaml file, or in the level 1 titles; the macros are correctly interpreted in the navigation part of the page.

1.0.1, 2023-05-25

1.0.0-alpha, 2023-04-23

• Improved user guide, with introduction of two new pages: "Controlling macro rendering" and "Post production".

• Fixed: (#158) In modules, on_pre_page_macros(), the env.markdown attribute is now available to create a header or footer.

• Changed: In on_post_page_macros() use env.markdown instead of env.raw_markdown, for the same purpose.

• Added: (#162) Allow opt-in of page rendering, by using parameter render_macros: true in yaml header of the page (requires render_by_default:false in the macro parameters, in the config file).

• Fixed: macro_info() now generates a header of category 2, so as to be used with other material in the same page, and not confuse the macro generators.

• Changed: ignore_macros: true in page header is deprecated. Use render_macros: false instead.

• Fixed: issues #155 (documentation type), #143 (git.tab), #135 (indicate page where rendering failed).

• Added: it is now possible to use macros in page titles, in the nav section of the yaml file, or in the level 1 titles; the macros are correctly interpreted in the navigation part of the page.

• Added: (#133) on_error_fail in config file to make build/serve process fail in case of macro error, with return code 100.

• Added: (#130) Documentation on the tree structure of a typical macro directory (package)

• Fixed: (#118) {{ git.date }} is now committer date (no longer author date).
• Added: new git info elements (author email, committer, committer email); documentation was updated
• Added: by default, unknown variables in a markdown page ({{ foo }}) are no longer replaced by blanks but displayed as is (DebugUndefined) (#117); for better compatibility with other plugins or error detection
• Added: on_undefined parameter in plugin definition to alter behavior with unknown jinja2 variables: 'keep' (default), 'silent', 'strict', 'lax'; documentation was updated

• Fixed: Broken build of 0.6.2

• Added: env.markdown is now modifiable, for use in on_post_page_macros()

• Fixed: documentation (for readthedocs) now contains proper link to edit uri on github
• Fixed: broken link in webdoc/docs/pages.md
• Bump version to 0.6.0, to acknowledge the breaking change in 0.5.10

• Fixed: Incompatibility with mkdocs 1.2 (on_serve() event, call to server.watch())

• Starting point

Now mkdocs-macros has has better integration with the general workflow

1. Metavariables declared in the YAML header of a markdown page are now directly accessible by macros in the page, without needing to go through the page.meta object (e.g. if the meta-variable foois declared in the YAML header, it can be accessible as {{ foo }} as well as {{ page.meta.foo }}. It makes using macros much simpler.

2. The console messages of mkdocs-macros are now integrated with the standard logging of MkDocs. It means that you can both suppress them (--quiet option) or expand them to include debug messages (--verbose).

3. Macros have their own trace function (chatter()) which writes into MkDocs' log as Info. If you are using the local server (mkdocs serve), you can toggle that trace on and off, with a verbose parameter in the plugin's configuration and this will be instantly reflected on the console.

4. The Python module can use a new on_post_build() function, for actions that need to take place after the HTML site directory is built (typically adding or modifying files).