OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated variables documentation

Browse Source
This commit is contained in:
squidfunk 2020-10-31 15:29:05 +01:00
parent 79e06cac0b
commit 0afab33187
1 changed files with 32 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/reference/variables.md
View File

@ -90,74 +90,68 @@ The unit price is 12.50.
### Using variables in snippets ### Using variables in snippets
You may want to use variables in snippets, for example, when describing the same procedure in multiple contexts where only one piece of information differs. This does not work with snippets that are included using the [Snippets](../abbreviations.md#snippets) extension. Instead, you can use the [macros](#macros) plugin for defining snippets. You may want to use variables in snippets, for example, when describing the same
procedure in multiple contexts where only one piece of information differs. This
does not work with snippets that are included using the [Snippets][2] extension.
Instead, you can use the [macros][3] plugin for defining snippets.
To this end, add the snippet location using the `include_dir` parameter to the plugin's configuration in `mkdocs.yml`, for example: To this end, add the snippet location using the `include_dir` parameter to the
plugin's configuration in `mkdocs.yml`, for example:
``` ``` yaml
plugins: plugins:
- search - search
- macros: - macros:
include_dir: snippets include_dir: snippets
``` ```
In your Markdown file, you call the snippets like In your Markdown file, you can include snippets with Jinja's [`include`][4]
function:
``` markdown ``` markdown
{% include 'snip.md' %} {% include "definitions.md" %}
``` ```
This example illustrates the behavior: This example illustrates the behavior:
=== "snippets/snip.md" === "snippets/definitions.md"
_Code_
``` markdown ``` markdown
Here goes the variable: {{ page.meta.variables.number }} The unit price is {{ page.meta.unit.price }}
``` ```
=== "docs/page1.md" === "docs/page-1.md"
_Code_
``` markdown ``` markdown
--- ---
variables: unit:
number: 500 price: 12.50
--- ---
{% include 'snip.md' %} {% include "definitions.md" %}
``` ```
_Result_ === "docs/page-2.md"
Here goes the variable: 500
=== "docs/page2.md"
_Code_
``` markdown ``` markdown
--- ---
variables: unit:
number: 1000 price: 25.00
--- ---
{% include 'snip.md' %} {% include "definitions.md" %}
``` ```
_Result_ [2]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
[3]: #macros
Here goes the variable: 1000 [4]: https://jinja.palletsprojects.com/en/2.11.x/templates/#include
## Customization ## Customization
### Custom macros ### Custom macros
The [macros][1] plugin allows to define custom macros, which can then be used The [macros][1] plugin allows to define custom macros, which can then be used
from Markdown files. See the [official documentation][2] for more information from Markdown files. See the [official documentation][5] for more information
how to define custom macros. how to define custom macros.
[2]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/python/ [5]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/python/