neoteroi-mkdocs provides a collection of plugins for MkDocs and Python Markdown, enhancing documentation sites with features like cards, contributors lists, timelines, Gantt charts, and OpenAPI specification integration. Currently at version 1.2.0, the library maintains an active development pace with regular updates and feature additions.
pip install neoteroi-mkdocsVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to set up a basic MkDocs project and enable two common neoteroi-mkdocs plugins: `cards` and `contribs`. It creates `mkdocs.yml` to configure the plugins and `docs/index.md` with example usage of their respective HTML/Markdown syntax. Finally, it starts the MkDocs development server to view the output.
Upgrade your Python environment to 3.10 or newer, or pin `neoteroi-mkdocs` to a version prior to 1.2.0 if Python 3.9 is strictly required.
Ensure the specified environment variable (e.g., `GIT_CONTRIBS_ON`) is set before running `mkdocs serve` or `mkdocs build` if you intend for the `contribs` plugin to be active. Otherwise, remove `enabled_by_env` from your configuration.
Upgrade `neoteroi-mkdocs` to version 1.1.1 or newer to avoid log pollution when working with uncommitted files. Alternatively, commit your files before running MkDocs.
If encountering dependency conflicts, use a tool like `pip-tools` (`pip-compile`) to manage and resolve your project's dependencies, or explicitly pin `mkdocs` and `httpx` to compatible versions in your `requirements.txt`.