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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file htmlextradata-0.1.4.tar.gz.

File metadata

  • Download URL: htmlextradata-0.1.4.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0

File hashes

Hashes for htmlextradata-0.1.4.tar.gz
Algorithm Hash digest
SHA256 742893707920169e09dd701b667dc75601cb74156a93f06ed7b323ac952a037e
MD5 5bb4c73c5bb33519168bbafd191788e0
BLAKE2b-256 ba91e96ede5de6abdba8bd2873b1b475766577a2c80e965c60b2144350b689eb

See more details on using hashes here.

File details

Details for the file htmlextradata-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: htmlextradata-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Darwin/23.0.0

File hashes

Hashes for htmlextradata-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 88e2affff76c2c15b5e4e1da9dc5df18145d04bf6393012ec6028051a793f0af
MD5 6d93c43477a16304015ae4131c4a5bd8
BLAKE2b-256 4f89995d7eab0716677be4aff64be0e4e608d55a5c298f788c122ff7ba97fdda

See more details on using hashes here.

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