mkdocs.yml

site_name: PolarStreams Documentation
repo_url: https://github.com/polarstreams/polar
edit_uri: blob/main/docs/
docs_dir: docs

nav:
  - Overview: 'README.md'
  - About: 'technical_intro/README.md'
  - Install: 'install/README.md'
  - Getting Started:
    - Getting Started on Docker: 'getting_started/on_docker/README.md'
    - Getting Started on Kubernetes: 'getting_started/on_kubernetes/README.md'
  - REST API docs: 'rest_api/README.md'
  - Benchmarks: 'benchmarks/README.md'
  - Features:
    - Partitioning: 'features/partitioning/README.md'
    - Modern I/O Techniques: 'features/io/README.md'
    - Built for Edge Computing: 'features/edge/README.md'
    - Metrics: 'features/metrics/README.md'
  - FAQ: 'faq/README.md'

copyright: >-


theme:
  name: material
  palette:
    primary: indigo
    accent: red
  font:
    text: Lato
    code: Ubuntu Mono
  logo: images/barco-dark.jpg
  favicon: images/barco-dark.jpg
  features:
    - navigation.sections

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - admonition

plugins:
  - search
  - build_plantuml:
      render: "server"
      server: "http://www.plantuml.com/plantuml"
      output_format: "png"
      diagram_root: "docs"
      output_folder: "target"
      input_folder: "diagrams"
      input_extensions: "puml"
  - macros