mkdocs.yml

site_name: sqlitecollections
site_description: Python collections that are backended by sqlite3 DB and are compatible with the built-in collections

theme:
  name: "material"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      primary: "light blue"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: "indigo"
repo_name: osoken/sqlitecollections
repo_url: https://github.com/osoken/sqlitecollections
plugins:
  - include-markdown
  - search
  - macros:
      module_name: docs/main
markdown_extensions:
  - pymdownx.highlight:
      linenums: false
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Overview: index.md
  - install.md
  - Usage:
      - common features: usage/common.md
      - List: usage/list.md
      - Dict: usage/dict.md
      - dictview:
          - usage/dictview/keysview.md
          - usage/dictview/valuesview.md
          - usage/dictview/itemsview.md
      - Set: usage/set.md
      - factory: usage/factory.md
      - metadata: usage/metadata.md
  - development.md
  - benchmark.md