mkdocs.yml sample for pybotters]

mkdocs.yml

site_name: "pybotters Docs"

nav:
  - "Introduction": "README.md"
  - "Usage":
      - "QuickStart": "Home.md"
      - "Advanced Usage": "Advanced-Usage.md"
  - "Guides":
      - "Exchanges": "Exchanges.md"
      - "Example": "Example.md"
  - "API Reference": "Reference.md"
  - "Contributing": "Contributing.md"

markdown_extensions:
  # Python Markdown
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.highlight
  - pymdownx.superfences

repo_url: https://github.com/MtkN1/pybotters
repo_name: MtkN1/pybotters

theme:
  name: material

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.sections
    - navigation.footer
    - content.code.copy