mkdocs.yml

site_name: pycrdt-websocket
site_description: Async WebSocket connector for pycrdt
repo_url: https://github.com/jupyter-server/pycrdt-websocket

theme:
  name: "material"
  palette:
    - scheme: default
      primary: "black"
      accent: "black"
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - scheme: slate
      primary: "black"
      accent: "black"
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.top
    - navigation.sections
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy

nav:
  - Overview: index.md
  - install.md
  - Usage:
      - usage/client.md
      - usage/server.md
      - usage/WebSocket_API.md
  - Contributing:
      - contributing.md
  - Code Reference:
      - reference/WebSocket_provider.md
      - reference/WebSocket_server.md
      - reference/ASGI_server.md
      - reference/Django_Channels_consumer.md
      - reference/WebSocket.md
      - reference/Room.md
      - reference/Store.md

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

plugins:
  - mkdocstrings:
      default_handler: python