mkdocs.yml

site_name: "Mininterface"
repo_name: CZ-NIC/mininterface
repo_url: https://github.com/CZ-NIC/mininterface
docs_dir: docs

theme:
  name: "material"

plugins:
  - search
  - mermaid2
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: table
            show_source: false
            members_order: source
            show_bases: false
            show_labels: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true # highlight code during build time, not in javascript
      linenums: false # enable line numbering
      linenums_style: pymdownx-inline # how lines are numbered
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences: # make exceptions to highlighting of code:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.keys # keyboard keys
  - tables
  - footnotes

nav:
  - Introduction: "index.md"
  - Overview: "Overview.md"
  - Run: "run.md"
  - Mininterface: "Mininterface.md"
  - Tag: "Tag.md"
  - Facet: "Facet.md"
  - Types: "Types.md"
  - Validation: "Validation.md"
  - Standalone: "Standalone.md"
  - Experimental: "Experimental.md"
  - Changelog: "Changelog.md"