Skip to content

Commit

Permalink
Minor corrections to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurent Franceschetti committed Feb 20, 2024
1 parent cfa03e7 commit bf6c8e4
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# MIT License
Copyright (C) 2018-2021 Laurent Franceschetti
Copyright (C) 2018-2024 Laurent Franceschetti

(see contributors for their respective portions)

Expand Down
3 changes: 2 additions & 1 deletion webdoc/docs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ or cause a syntax error, or some other error.
That is because Mkdocs-Macros might confuse snippets in those pages
with Jinja2 statements, try to render them and fail.

This issue (as well as its solutions) is described under the
This issue (as well as its solutions) is described in the chapter
on [rendering](rendering.md).


5 changes: 3 additions & 2 deletions webdoc/docs/rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and [comments](https://jinja.palletsprojects.com/en/3.1.x/templates/#comments) i
This page may be useful for **large MkDocs projects**
that have decided to:

- adopt Mkdocs-Macros at a latet stage of their existence;
- adopt Mkdocs-Macros at a later stage of their existence;
- include a **subproject** using Mkdocs-Macros into a main project
that doesn't.

Expand Down Expand Up @@ -239,7 +239,8 @@ Mkdocs-Macros will _not_ attempt to render the other pages.

_From version 1.1.0_

When `render_macros`is set to `false`, the parameter `force_render_paths`
When `render_macros` is set to `false` in the config file,
the parameter `force_render_paths`
can be used to specify a list of **exceptions** (**opt-in**) i.e.
relative paths of pages within the documents directory
(as well as file patterns) in which macros must be rendered.
Expand Down

0 comments on commit bf6c8e4

Please sign in to comment.