DOCSEARCHbyAlgolia
Submit Docs

neoteroi-mkdocs Plugins

repository·main·Indexed 41 days ago

https://github.com/neoteroi/mkdocs-plugins

A collection of MkDocs plugins and Python Markdown extensions for adding visual components like cards, timelines, and Gantt charts, as well as specialized capabilities such as OpenAPI generation via mkdocsoad and contributor metadata display.

Tokens
349
Snippets
2
Records
3
Agent score
2%

What's inside neoteroi-mkdocs

  1. Overview of neoteroi-mkdocs plugins and extensions

    main

    The neoteroi-mkdocs package provides a suite of tools for enhancing MkDocs documentation, including OpenAPI generation, visual components, and metadata display.

    Available Components

    NameDescription
    mkdocsoadGenerates documentation from OpenAPI specification files.
    cardsComponent to display cards.
    timelineComponent to display chronological information with style.
    ganttComponent to display Gantt diagrams.
    spantableTables supporting colspan and rowspan.
    contribsMkDocs plugin to display last commit time and contributors for each file.

  2. Compile styles using Sass

    main

    The project's styles are distributed as Sass files. To generate the final CSS files, you must have Sass installed on your system. Use the sass command to compile the source SCSS files into a compressed CSS file. It is recommended to use the --no-source-map and --style compressed flags for production-ready output.

    sass --no-source-map --style compressed styles/all.scss ~/projects/github/mkdocs-plugins-docs/docs/css/neoteroi.css