Добавить пользовательские метаданные в mkdocs

Есть ли способ разместить пользовательский метатег на странице? Я попытался добавить его, как сказано в документации, но в метаданные анализируются только стандартные теги. Пользовательские теги игнорируются.


person Maks    schedule 23.09.2019    source источник
comment
Я обнаружил, что могу создать свою собственную тему или изменить существующую. Кажется хакерским   -  person Maks    schedule 23.09.2019


Ответы (1)


MkDocs включает поддержку только двух ключей метаданных:

  • template: шаблон для использования с текущей страницей.
  • title: «Заголовок» документа.

Если вы хотите использовать любые другие ключи метаданных, то документация объясняет, что...

Пары ключ/значение передаются MkDocs в шаблон страницы. Поэтому, если тема включает поддержку, значения любых ключей могут отображаться на странице или использоваться для управления отрисовкой страницы. См. документацию вашей темы для получения информации о том, какие ключи могут поддерживаться, если таковые имеются.

Итак, вам нужно создать или изменить тему, чтобы она использовала метаданные. Вы можете найти некоторые сторонние темы, которые уже делают это, или вы можете создать свою собственную тему.

person Waylan    schedule 01.10.2019