Metadata-Version: 2.1
Name: htmlextradata
Version: 0.1.4
Summary: MkDocs Plugin
Home-page: https://github.com/stalexsm/mkdocs-htmlextradata-plugin
License: MIT
Keywords: mkdocs,mkdocs-plugin
Author: Alexandr Starovoytov
Author-email: stalex.info@yandex.ru
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: mkdocs (>=1.4.0,<2.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Project-URL: Repository, https://github.com/stalexsm/mkdocs-htmlextradata-plugin
Description-Content-Type: text/markdown

# MkDocs-htmlextradata-plugin

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

## Установка

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

```bash
pip install htmlextradata

or

poetry add htmlextradata
```

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

```yaml
plugins:
    - search
    - htmlextradata
```

или

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

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

