Skip to content

Releases: Neoteroi/mkdocs-plugins

v0.0.9

02 Oct 21:28
d1ec35b
Compare
Choose a tag to compare

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

01 Oct 08:27
Compare
Choose a tag to compare
  • 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!


CSS dist package

v0.0.7

01 Oct 08:10
b933457
Compare
Choose a tag to compare
  • 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

11 Aug 21:26
9d9b828
Compare
Choose a tag to compare
  • 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
  • Adds the Cards extension, to render cards
  • Adds the Timeline extension, to render timelines
  • Adds the Projects extension, with a control to render Gantt 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

08 May 12:19
a2a6e46
Compare
Choose a tag to compare
  • Adds support for OAD specification organized in different files (fix #5)
  • Improves mkdocsoad.css

v0.0.4

04 May 21:53
0c305cd
Compare
Choose a tag to compare

v0.0.3

04 May 21:14
bef3bfc
Compare
Choose a tag to compare
  • Fixes bug #4

v0.0.2

01 May 20:11
a6cbe99
Compare
Choose a tag to compare
  • Adds the first extension for Python Markdown of the repository:
    spantable, custom Markdown table with support for colspan and rowspan
  • Improves the support for Material for MkDocs themes in mkdocsoad

v0.0.1

20 Apr 23:07
Compare
Choose a tag to compare

MkDocsOAD

Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger documentation).

How to use:

  1. Install using pip install neoteroi-mkdocs
  2. Configure this plugin in the MkDocs configuration file:
plugins:
  - neoteroi.mkdocsoad
  1. Configure a source in your Markdown file, for example having a swagger.json
    file in your docs 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:

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)]