Mkdocs & Plugins¶

Mkdocs¶

Installation mkdocs¶

Text Only
1 2 3 4 5 6 7	`pip install mkdocs mkdocs new my-project cd my-project mkdocs serve`

Plugin¶

Extention mkdocs-material¶

Bash

pip install mkdocs-material
pip install mkdocs-glightbox
pip install mkdocs-table-reader-plugin

mkdocs-glightbox

https://github.com/blueswen/mkdocs-glightbox#usage

table-reader-plugin (Read external CSV file and more [ json,yaml,...] )

https://timvink.github.io/mkdocs-table-reader-plugin/#documentation-and-how-to-guides

Configuration plugin

plugins:
  - glightbox
  - table-reader

Extention mkdocs-material mermaid¶

Configuration mkdocs.yml

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format