mkdocs.md

Welcome to MkDocs

For full documentation visit mkdocs.org.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

https://squidfunk.github.io/mkdocs-material/creating-your-site/ https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/ https://www.mkdocs.org/getting-started/ https://github.com/mkdocs/mkdocs

https://github.com/tiangolo/fastapi

mkdocs serve

pip install mkdocs-markdownextradata-plugin

https://github.com/rosscdh/mkdocs-markdownextradata-plugin

pip install mkdocs-drawio-exporter https://github.com/LukeCarrier/mkdocs-drawio-exporter

mdx-include pip install mdx-include

Command Line Interface

Content tabs Code blocks Data tables Diagrams