Skip to content

mkdocs

Warning

In progress...

Todo

  • Briefly describe mkdocs
  • Add example mkdocs.yml
  • Add snippets for common plugins I use
    • Configurations
      • Top level keys
        • site_name
        • site_description
        • repo_name
        • repo_url
        • exclude_docs
      • theme configuration for mkdocs-material
        • light/dark toggle
        • custom icons/fonts
        • mkdocs-material features
        • search
        • navigation
        • content
      • plugins
        • literate-nav
        • section-index
      • markdown_extensions