Releases: Neoteroi/mkdocs-plugins
Releases · Neoteroi/mkdocs-plugins
v0.0.9
Improves the contributors plugin:
- Adds the possibility to exclude contributor information (for example to not display contributions from bots).
- Adds the possibility to merge contributors' information for cases in which the same person commits using two different email addresses.
- Adds the possibility to display an element with the count of contributors.
v0.0.8
- Improves the Gantt extension:
-
- now supports multiple periods in the same row
-
- now supports activities using the start date from the previous activity (automatic dates)
- Adds a contributors plugin (
neoteroi.contribs
) to display contributors'
information in each page, obtaining information from the Git repository at
build time - Increases the version of pinned dependencies (httpx and mkdocs)
Corrects error published in v0.0.7
.
Thanks to @chrfla-cognite for his first contribution!
v0.0.7
- Improves the Gantt extension:
-
- now supports multiple periods in the same row
-
- now supports activities using the start date from the previous activity (automatic dates)
- Adds a contributors plugin (
neoteroi.contribs
) to display contributors'
information in each page, obtaining information from the Git repository at
build time - Increases the version of pinned dependencies (httpx and mkdocs)
Thanks to @chrfla-cognite for his first contribution!
v0.0.6
- Adds common classes to enable custom extensions reading configuration from:
-
- YAML, JSON, or CSV embedded in the markdown source
-
- YAML, JSON, or CSV fetched from a URL at build time (simple HTTP GET), with the
option to define a custom fetcher for example for use cases that require
authentication
- YAML, JSON, or CSV fetched from a URL at build time (simple HTTP GET), with the
- Adds the
Cards
extension, to render cards - Adds the
Timeline
extension, to render timelines - Adds the
Projects
extension, with a control to renderGantt
diagrams ✨ - Adds the link to the documentation site
- Drops support for Python 3.7 in the build pipeline (code might still work but is not ensured)
Downloads:
v0.0.5
v0.0.4
v0.0.3
v0.0.2
- Adds the first extension for Python Markdown of the repository:
spantable
, custom Markdown table with support forcolspan
androwspan
- Improves the support for Material for MkDocs themes in
mkdocsoad
v0.0.1
MkDocsOAD
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger documentation).
How to use:
- Install using
pip install neoteroi-mkdocs
- Configure this plugin in the MkDocs configuration file:
plugins:
- neoteroi.mkdocsoad
- Configure a source in your Markdown file, for example having a
swagger.json
file in yourdocs
folder:
[OAD(./docs/swagger.json)]
The plugin fetches the contents from the OpenAPI Specification source,
generates Markdown using essentials-openapi,
then writes them in the markdown file.
Example result:
Supported sources for OpenAPI Documentation
Source | Example |
---|---|
YAML file | [OAD(./docs/swagger.yaml)] |
JSON file | [OAD(./docs/swagger.json)] |
URL returning YAML on HTTP GET | [OAD(https://example-domain.net/swagger/v1/swagger.yaml)] |
URL returning JSON on HTTP GET | [OAD(https://example-domain.net/swagger/v1/swagger.json)] |