Skip to content

Commit

Permalink
Fix imprecision in description of parameters for jinja2 syntax (#252)
Browse files Browse the repository at this point in the history
  - update CHANGELOG
  - update authors
  • Loading branch information
Laurent Franceschetti committed Nov 3, 2024
1 parent 4fb7bf6 commit 0bc57e3
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Changelog: Mkdocs-Dacros
# Changelog: Mkdocs-Macros

All notable changes to this project are documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 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.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ readme = "README.md"
license = { text = "MIT" }
requires-python = ">=3.8"
authors = [
{ name = "Laurent Franceschetti", email = "[email protected]" },
{ name = "Laurent Franceschetti"},
]
keywords = [
"macros",
Expand Down
4 changes: 2 additions & 2 deletions webdoc/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,8 +349,8 @@ of the MkDocs' config file:
| `j2_block_end_string` || [Non-standard Jinja2 marker for end of block](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_variable_start_string` || [Non-standard Jinja2 marker for start of variable](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_variable_end_string` || [Non-standard Jinja2 marker for end of variable](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_comment_start_string` || [Non-standard Jinja2 marker for end of variable](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_comment_end_string` || [Non-standard Jinja2 marker for end of variable](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_comment_start_string` || [Non-standard Jinja2 marker for start of comment](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
| `j2_comment_end_string` || [Non-standard Jinja2 marker for end of comment](rendering.md/#solution-5-altering-the-syntax-of-jinja2-for-mkdocs-macros)
|`on_error_fail`|`false`| [Make the building process fail in case of an error in macro rendering](troubleshooting.md/#make-the-build-process-fail-in-case-of-error) (this is useful when the website is rebuilt automatically and errors must be detected.)
|`on_undefined`|keep|[Behavior of the macros renderer in case of an undefined variable in a page](troubleshooting.md/#is-it-possible-to-make-the-building-process-fail-in-case-of-page-error). By default, it leaves the Jinja2 statement untouched (e.g. `{{ foo }}` will appear as such in the page.) Use the value 'strict' to make it fail.
|`verbose`|`false`| Print [debug (more detailed) statements](troubleshooting.md/#verbose-debug-statements-in-macros) in the console.
Expand Down

0 comments on commit 0bc57e3

Please sign in to comment.