neoteroi-mkdocs

What it is and what it does

neoteroi-mkdocs is a bundle of six MkDocs plugins and Markdown extensions designed to enhance documentation sites with richer visual components and automated API documentation. The core offering is mkdocsoad, which generates full API documentation directly from OpenAPI specification files, eliminating manual API docs maintenance. The package also includes four visual component extensions—cards, timeline, gantt, and spantable—that let you render styled, interactive elements in Markdown without writing HTML, plus a contribs plugin that tracks file contributors and last-commit metadata.

The package depends on click, essentials-openapi, httpx, jinja2, mkdocs, and rich, making it a fairly self-contained addition to an existing MkDocs setup. It targets modern Python versions (3.9 through 3.14) and is classified as production-stable. The aging maintenance status (264 days since last commit) suggests the core functionality is mature but not actively developed; the repository remains public and receives occasional updates.

Use it for:

• Auto-generate API documentation from OpenAPI/Swagger specs without manual page creation.
• Build styled project timelines or Gantt charts directly in Markdown for roadmap or schedule documentation.
• Create card-based layouts for feature highlights, team members, or service listings in your docs site.
• Use tables with colspan and rowspan support for complex data layouts that standard Markdown cannot express.
• Track and display file contributors and last-commit timestamps on documentation pages for transparency.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides a collection of MkDocs plugins and Markdown extensions for generating API documentation from OpenAPI specs and rendering styled components like cards, timelines, Gantt diagrams, and enhanced tables.

Yes, if you use MkDocs and need OpenAPI documentation generation or styled visual components. The low install friction, permissive license, and production-stable status make it a safe addition. The aging maintenance is not a blocker—the plugins appear feature-complete—but verify that the specific plugins you need match your MkDocs version and theme before committing to a large documentation migration.

Install

neoteroi-mkdocs on PyPI

pip install neoteroi-mkdocs

uv add neoteroi-mkdocs

poetry add neoteroi-mkdocs

Installing neoteroi-mkdocs

Before you install

Low install friction with a pure-Python wheel distribution. Maintenance status is aging—last commit was 264 days ago—but the repository remains active and not archived, with 175 stars indicating modest adoption.

License in practice

Licensed under MIT (permissive), so you can use, modify, and distribute this package freely with minimal restrictions.

Quickstart

pip install neoteroi-mkdocs

# In mkdocs.yml, enable a plugin:
plugins:
  - mkdocsoad
  - cards

# Then use in Markdown:
# [OpenAPI spec or card syntax in your .md files]

Requires Python >=3.9 and an existing MkDocs project to integrate plugins into.

Verify before relying

• Whether all six plugins (mkdocsoad, cards, timeline, gantt, spantable, contribs) are equally mature or if some are experimental.
• Performance impact of rendering complex Gantt diagrams or large OpenAPI specs on build time.
• Compatibility with specific MkDocs themes or whether plugins work universally.

Package facts

Evidence: neoteroi_mkdocs-1.2.0-py3-none-any.whl

Keywords: Markdown, MkDocs, OpenAPI, Swagger, documentation, extensions, plugins

Tags

More Documentation packages