From bf6c8e4cd0cb0dee9999103d44f18550aaeee82b Mon Sep 17 00:00:00 2001 From: Laurent Franceschetti Date: Tue, 20 Feb 2024 11:04:18 +0100 Subject: [PATCH] Minor corrections to the documentation --- LICENSE.md | 2 +- webdoc/docs/advanced.md | 3 ++- webdoc/docs/rendering.md | 5 +++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 65ad968..a028598 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,5 +1,5 @@ # MIT License -Copyright (C) 2018-2021 Laurent Franceschetti +Copyright (C) 2018-2024 Laurent Franceschetti (see contributors for their respective portions) diff --git a/webdoc/docs/advanced.md b/webdoc/docs/advanced.md index a124cae..3141deb 100644 --- a/webdoc/docs/advanced.md +++ b/webdoc/docs/advanced.md @@ -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). diff --git a/webdoc/docs/rendering.md b/webdoc/docs/rendering.md index 3308e6c..4303125 100644 --- a/webdoc/docs/rendering.md +++ b/webdoc/docs/rendering.md @@ -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. @@ -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.