Create your docs
After you've completed installation, you can create your project documentation using the mkdocs command. Go to the directory where you want your project to be located and run:
Configure
Configure the documentation to use the material2014 theme:
Specify a primary color for your documentation. To make a good choice, consider choosing one of OG Material colors.
Recommended config
You can consider adding these features to your config, which will help your documentation greatly:
plugins:
- mermaid2
- ezglossary:
tooltip: full
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
markdown_extensions:
- toc:
toc_depth: 3
- extra
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid_custom
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- attr_list
- md_in_html
- def_list
- material2014.extensions.tabbed
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.tasklist:
custom_checkbox: true
Note
All examples in this documentation are written with these extensions and plugins.