html - MkDocs 中的全局变量

Question

我有一个用 MkDocs 制作的文档项目.我想在配置文件 (mkdocs.yml) 中定义全局变量，以便在 Markdown 页面 (*.md) 中使用。

阅读此 issue ，似乎可以通过在 mkdocs.yml 文件中包含一个 extra 配置来完成，例如:

extra:
    version: 1.0

...然后，在页面中使用该变量，例如如下:

---> My version: {{ config.extra.version }}

我试过了，但不幸的是它在我的示例中不起作用(没有变量替换):

• 我做错了什么吗？
• 是否有可能完成这项工作？

Answer 1

不，目前这是不可能的。

您说您“在页面中使用该变量”。我假设你的意思是“ Markdown ”页面。目前模板变量在 Markdown 页面中不可用。模板引擎甚至不针对 Markdown 运行。 Markdown 解析器的输出是传递给模板的变量之一。有关其工作原理的更详细说明，请参阅我对 How do you include flask/jinja2 code inside a markdown file? 的回答。 .

特定于 MkDocs，有一个 Unresolved 问题 (#304) 讨论添加一个功能以支持 Markdown 页面中的一些有限模板，但它计划在 1.0 之后发布，因此目前不是最优先考虑的问题。