mkdocs.yml

---
site_name: fakeredis
site_author: Daniel Moran
site_description: >-
  Documentation for fakeredis python library
# Repository
repo_name: cunla/fakeredis
repo_url: https://github.com/cunla/fakeredis

# Copyright
copyright: Copyright © 2022 - 2023 Daniel Moran

extra:
  generator: false
  analytics:
    provider: google
    property: G-GJBJBKXT19
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: cunla
      repo: fakeredis
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Redis stack: redis-stack.md
  - Dragonfly support: dragonfly-support.md
  - Valkey support: valkey-support.md
  - Supported commands:
    - 'supported-commands/index.md'
    - Redis commands:
        - Bitmap: supported-commands/Redis/BITMAP.md
        - Cluster: supported-commands/Redis/CLUSTER.md
        - Connection: supported-commands/Redis/CONNECTION.md
        - Generic: supported-commands/Redis/GENERIC.md
        - Geospatial indices: supported-commands/Redis/GEO.md
        - Bitmap: supported-commands/Redis/BITMAP.md
        - Hash: supported-commands/Redis/HASH.md
        - HyperLogLog: supported-commands/Redis/HYPERLOGLOG.md
        - List: supported-commands/Redis/LIST.md
        - Pub/Sub: supported-commands/Redis/PUBSUB.md
        - Scripting: supported-commands/Redis/SCRIPTING.md
        - Server: supported-commands/Redis/SERVER.md
        - Set: supported-commands/Redis/SET.md
        - Sorted Set: supported-commands/Redis/SORTEDSET.md
        - Stream: supported-commands/Redis/STREAM.md
        - String: supported-commands/Redis/STRING.md
        - Transactions: supported-commands/Redis/TRANSACTIONS.md
    - RedisJSON commands: supported-commands/RedisJson/JSON.md
    - Time Series commands: supported-commands/RedisTimeSeries/TIMESERIES.md
    - Probabilistic commands:
        - Bloom Filter: supported-commands/RedisBloom/BF.md
        - Cuckoo Filter: supported-commands/RedisBloom/CF.md
        - Count-Min Sketch: supported-commands/RedisBloom/CMS.md
        - t-digest: supported-commands/RedisBloom/TDIGEST.md
        - top-k: supported-commands/RedisBloom/TOPK.md
    - Search commands: supported-commands/RedisSearch/SEARCH.md
    - Suggestion commands: supported-commands/RedisSearch/SUGGESTION.md
    - Dragonfly commands: supported-commands/DRAGONFLY.md
  - Guides:
      - Implementing support for a command: guides/implement-command.md
      - Write a new test case: guides/test-case.md
  - About:
      - Release Notes: about/changelog.md
      - Contributing: about/contributing.md
      - License: about/license.md

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    # - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
#    - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    - navigation.prune
    - navigation.sections
    # - navigation.tabs.sticky
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  highlightjs: true
  hljs_languages:
    - yaml
    - django