📖 mkdocs + 👁️ iolanta

Features

By integrating MkDocs static site builder with Iolanta knowledge management workspace, you can empower your static site with:

Automatic page → page 🔗 links;
Tables generated from YAML data;
Project roadmaps;
Architecture Decision Records.
Something missing? Or anything doesn't work? Submit ➕ an issue!

Installation

Python ⩾ 3.10 required.

mkdocs-iolanta is on PyPI.

pip install mkdocs-iolanta

Configuration

Open your mkdocs.yml configuration file and configure its plugins section as follows:

plugins:
  - search                  # (1)!
  - …
  - iolanta                 # (2)!
  - macros:                 # (3)!
      on_error_fail: true   # (4)!
  - …

The search plugin is built-in and automatically enabled if mkdocs.yml does not specify any plugins at all. But if it does, this built-in plugin must be enabled explicitly.
Support iolanta capabilities for this documentation site.
This enables mkdocs-macros-plugin which is required to utilize Iolanta capabilities on MkDocs pages, such as {% raw %}{{ render("render") }}{% endraw %} macro.
This setting is highly recommended. If there is an error during rendering MkDocs macros, including those macros provided by Iolanta, the site build will throw an error — making the issue easier to notice both on local development and in CI.

Release files for mkdocs-iolanta 0.1.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-iolanta 0.1.16
File	Size	Uploaded
mkdocs_iolanta-0.1.16.tar.gz	32.5 kB	Dec 7, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-iolanta 0.1.16
File	Interpreter	ABI	Platform	Reset
mkdocs_iolanta-0.1.16-py3-none-any.whl 38.1 kB Dec 7, 2024	Python 3	none	any	Details

Total release size: 70.6 kB

Release files / mkdocs_iolanta-0.1.16.tar.gz

Download URL	mkdocs_iolanta-0.1.16.tar.gz
Size	32.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`d1d7879b7d5248a53022db8d4db5f84565ba85d5cfdec7c474a9f1c249d5fb9a`
BLAKE2b-256 checksum How to use checksums	`3fe81b8bc49084737efc82a5b24ab225f0c99e7a9efc85d691372fbe9db69e46`
Upload date	Dec 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.4 CPython/3.11.7 Linux/6.2.0-39-generic`

Release files / mkdocs_iolanta-0.1.16-py3-none-any.whl

Download URL	mkdocs_iolanta-0.1.16-py3-none-any.whl
Size	38.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1c1d2cfcf96fa9f8f3db9e81136e0debbc8290c37d36f9c9ece2194a76a317f3`
BLAKE2b-256 checksum How to use checksums	`ecc2342d9701a284f566e45b759686d07235cb0c0acb3cb4417040ac9dddfacf`
Upload date	Dec 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.4 CPython/3.11.7 Linux/6.2.0-39-generic`