Глобальные переменные в MkDocs

Question

У меня есть проект документации, составленный с помощью MkDocs. Я хотел бы определить глобальные переменные в файле конфигурации (mkdocs.yml), который будет использоваться на страницах разметки (*.md).

Читая эту issue, кажется, что это может быть сделано путем включения extra конфигурации в файле mkdocs.yml, например:

extra: 
    version: 1.0 

... а затем, использовать эту переменную в страницу, например, следующим образом:

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

Я попробовал, но, к сожалению, это не не работает в моем примере (без переменной substution):

• Я что-то не так?
• Возможно ли сделать эту работу?

Answer 1

Нет, это невозможно в это время.

Вы говорите, что используете эту переменную на странице. Я предполагаю, что вы имеете в виду страницу «Markdown». В это время шаблонные переменные недоступны на страницах Markdown. Механизм шаблонов даже не работает против Markdown. Результат анализатора Markdown является одной из переменных, переданных шаблону. Для более подробного объяснения того, как это работает, см. Мой ответ на How do you include flask/jinja2 code inside a markdown file?.

Специфичный для MkDocs, есть открытая проблема (#304), в которой обсуждается добавление функции для поддержки некоторых ограниченных шаблонов на страницах Markdown, но это запланировано для post-1.0, поэтому в настоящее время это не главный приоритет.