mkdocs.yml

site_name: "Project Cards"
site_url: https://network-wrangler.github.io/projectcard
repo_url: https://github.com/network-wrangler/projectcard

nav:
    - 'index.md'
    - 'json-schemas.md'
    - 'datamodels.md'
    - 'api.md'
    - 'examples.md'
    - 'how-to.md'
    - 'development.md'

theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.indexes
    - navigation.tabs
    - navigation.expand
    - toc.integrate
    - toc.follow
  palette:
    - scheme: default
      primary: blue grey
      accent: amber
  icon:
    logo: material/playlist-check

plugins:
  - autorefs
  - awesome-pages
  - include-markdown:
      opening_tag: "{!"
      closing_tag: "!}"
  - macros
  - mermaid2
  - mike
  - mkdocs-jupyter:
      include_source: True
  - mkdocstrings:
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          selection:
            new_path_syntax: true
          rendering:
            show_root_heading: true
            show_source: true
            heading_level: 3
  - search

extra:
  version:
    provider: mike
    default: latest

extra_javascript:
  - https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.min.js
  - javascript/schema_doc.min.js

extra_css:
  - extra_css/extra.css

markdown_extensions:
  - admonition
  - codehilite:
      linenums: true
  - meta
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.smartsymbols
  - smarty
  - toc:
      # insert a blank space before the character
      permalink: " ¶"