This repo contains documentation site for ODM product.
Documentation site is based on Material for MkDocs.
The documentation based on Markdown Syntax. Also it supports Extended Syntax.
Also there is a lot of additional markdown features. See the reference.
If something does not work please feel free to contact with developers.
pip install mkdocs-material
pip install mike
To serve documentation on localhost:
mkdocs serve
Deployment latest version is configured via Github Actions.
Mike plugin is used for deploying versions.
To deploy a new version create a new branch with pattern v*.*.*
(for example v1.54.2
) and push it.
A new folder will be created in gh-pages
branch that will be available on Github Pages after some time.