Skip to main content

MkDocs Plugin

Project description

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 }}, если есть страница с таким именем.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

htmlextradata-0.1.4.tar.gz (2.8 kB view hashes)

Uploaded Source

Built Distribution

htmlextradata-0.1.4-py3-none-any.whl (3.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page