MkDocs中的全局变量

Question

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

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

extra:
    version: 1.0

..。然后，在页面中使用该变量，例如如下所示：

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

我尝试过这样做，但不幸的是，它在我的示例中不起作用(没有变量子研究)：

​

​

• 我做错了什么吗？
• 这是可行的吗？

Answer 1

不，这个时候是不可能的。

你说你“在页面中使用那个变量”。我猜你的意思是“标记”一页。此时，模板变量在Markdown页面中不可用。模板引擎甚至不针对Markdown运行。Markdown解析器的输出是传递给模板的变量之一。有关如何工作的更详细说明，请参见我对如何在标记文件中包含烧瓶/jinja2 2代码？的回答。

特定于MkDocs，有一个未解决的问题(#304)正在讨论添加一个特性来支持Markdown页面中的一些有限的模板，但是它被安排在1.0后，所以现在它不是最高优先级。

Answer 2

给出的答案已经过时了，因为这可以用上面提到的宏或标记外数据这样的插件来完成，但您只需要引用{{ version }}。

Answer 3

作为更新，可以在extra插槽中插入mkocs.yml中的变量，正如您所描述的那样。

要做到这一点，您需要安装标记外数据插件。