mkdocs.yml

site_name: Atomix
site_url: https://atomix.io
copyright: Copyright © 2022 Intel Corporation
repo_url: https://github.com/atomix/atomix

plugins:
  - search
  - blog
  - minify:
      minify_html: true

theme:
  name: material
  custom_dir: docs/overrides
  favicon: images/favicon.png
  logo: images/logo.png
  include_search_page: false
  search_index_only: true
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-auto
        name: Switch to system color scheme
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    - navigation.instant
    # - navigation.prune
    # - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
    - toc.integrate

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - user-guide/index.md
      - Architecture: user-guide/architecture.md
      - Application Development:
          - user-guide/development/index.md
          - Go: user-guide/development/go.md
          - Java: user-guide/development/java.md
          - Primitives:
              - user-guide/development/primitives/index.md
              - Counter: user-guide/development/primitives/counter.md
              - CounterMap: user-guide/development/primitives/countermap.md
              - IndexedMap: user-guide/development/primitives/indexedmap.md
              - LeaderElection: user-guide/development/primitives/election.md
              - List: user-guide/development/primitives/list.md
              - Lock: user-guide/development/primitives/lock.md
              - Map: user-guide/development/primitives/map.md
              - MultiMap: user-guide/development/primitives/multimap.md
              - Set: user-guide/development/primitives/set.md
              - Topic: user-guide/development/primitives/topic.md
              - Value: user-guide/development/primitives/value.md
      - Deployment and Operations:
          - user-guide/deployment/index.md
          - Installation: user-guide/deployment/installation.md
          - Storage Profiles: user-guide/deployment/storage-profiles.md
          - Data Stores:
              - user-guide/deployment/data-stores/index.md
              - ConsensusStore: user-guide/deployment/data-stores/consensus.md
              - GossipStore: user-guide/deployment/data-stores/gossip.md
              - PodMemoryStore: user-guide/deployment/data-stores/pod-memory.md
              - SharedMemoryStore: user-guide/deployment/data-stores/shared-memory.md
  - Contributor Guide:
      - contributor-guide/index.md
      - SDKs: contributor-guide/sdk.md
      - Data stores: contributor-guide/data-stores.md
  - Reference:
      - reference/index.md
      - Go: https://pkg.go.dev/github.com/atomix/go-sdk
      - Protobuf:
          - atomix.runtime.counter.v1: reference/api/atomix/runtime/counter/v1/counter.md
          - atomix.runtime.countermap.v1: reference/api/atomix/runtime/countermap/v1/countermap.md
          - atomix.runtime.election.v1: reference/api/atomix/runtime/election/v1/election.md
          - atomix.runtime.indexedmap.v1: reference/api/atomix/runtime/indexedmap/v1/indexedmap.md
          - atomix.runtime.list.v1: reference/api/atomix/runtime/list/v1/list.md
          - atomix.runtime.lock.v1: reference/api/atomix/runtime/lock/v1/lock.md
          - atomix.runtime.map.v1: reference/api/atomix/runtime/map/v1/map.md
          - atomix.runtime.multimap.v1: reference/api/atomix/runtime/multimap/v1/multimap.md
          - atomix.runtime.v1: reference/api/atomix/runtime/v1/primitive.md
          - atomix.runtime.set.v1: reference/api/atomix/runtime/set/v1/set.md
          - atomix.runtime.topic.v1: reference/api/atomix/runtime/topic/v1/topic.md
          - atomix.runtime.value.v1: reference/api/atomix/runtime/value/v1/value.md
  - Blog:
      - blog/index.md

markdown_extensions:
  - toc:
      permalink: true
      title: "Table of contents"
  - smarty
  - meta
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight:
      use_pygments: true
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/atomix/atomix
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/orgs/atomix/repositories
    - icon: fontawesome/brands/java
      link: https://github.com/atomix/java-sdk
    - icon: fontawesome/brands/golang
      link: https://github.com/atomix/go-sdk
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/atomixio
  generator: false