Skip to content

stalexsm/mkdocs-htmlextradata-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs-htmlextradata-plugin

Плагин MkDocs, который вводит дополнительную переменную extradata в html-шаблон. Данная переменная попадает в контекст страницы, если файл .yml называется так же ка странца .md

Установка

Установите пакет с помощью pip или poetry:

pip install htmlextradata

or

poetry add htmlextradata

Включите плагин в вашем "mkdocs.yml`:

plugins:
    - search
    - htmlextradata

или

plugins:
    - search
    - htmlextradata:
        data: path/to/datafiles

По умолчанию он будет искать в папке, где хранится ваш mkdocs.yml, и в папке docs другую папку с именем _extradata (т.е. ./docs/_extradata/mtrs.yaml), доступную в шаблоне как {{ extradata }}, если есть страница с таким именем.

About

Mkdocs Plugins

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages