mkdocs.yml

site_name: Pydbm
site_description: Pydbm is a more pythonic way to use dbm.
site_url: https://pydbm.hakancelik.dev

repo_url: https://github.com/hakancelikdev/pydbm
repo_name: hakancelikdev/pydbm
edit_uri: https://github.com/hakancelikdev/pydbm/tree/main/docs

copyright: Copyright © 2020 - 2020 Hakan Çelik

markdown_extensions:
  - fenced_code
  - footnotes
  - tables
  - codehilite
  - legacy_em
  - meta
  - sane_lists
  - smarty
  - toc:
      permalink: true
      baselevel: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid-experimental
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      separator: '[\s\-\.]+'
      prebuild_index: true
  - git-revision-date-localized:
      type: date
      enable_creation_date: true
  - minify:
      minify_html: true
  - mike:
      canonical_version: latest

extra:
  version:
    provider: mike
    default: latest
  analytics:
    provider: google
    property: G-2EGM5WWEED
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/hakancelikdev
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/hakancelikdev
    - icon: fontawesome/solid/globe
      link: https://hakancelik.dev
  homepage: https://pydbm.hakancelik.dev

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  logo: 'assets/images/logo.png'
  favicon: 'assets/images/logo.png'
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Noto Sans
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github

nav:
  - Overview: index.md
  - Install: installation.md
  - User Guide:
      - tutorial/models.md
      - tutorial/model-config.md
      - tutorial/field-types.md
      - tutorial/validators.md
  - Contributing: CONTRIBUTING.md
  - Changelog: CHANGELOG.md
  - Authors: AUTHORS.md