mkdocs.yml

# Project information
site_name: Synse
site_description: A platform for infrastructure monitoring and control.
site_author: Vapor IO
copyright: 'Copyright © 2020 Vapor IO'


# Repository
repo_name: vaporio/synse-docs
repo_url: https://github.com/vapor-ware/synse-docs
edit_uri: tree/master/docs


# Configuration
theme:
  name: material

  # Default values
  feature:
    tabs: true
  palette:
    primary: green
    accent: green
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/img/favicon.ico
  logo: assets/img/logo-white.png

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true


# Navigation
nav:
  - Home: index.md
  - Plugins: plugins.md
  - Helm Charts: helm.md
  - Contributing: contributing.md
  - Releases: releases.md
  - License: license.md
  - Synse Server:
    - Introduction: server/intro.md
    - v3 API Reference: server/api.v3.md
    - User Guide:
      - Getting: server/user/getting.md
      - Quickstart: server/user/quickstart.md
      - Configuration: server/user/configuration.md
      - Device Tags: server/user/tags.md
      - Deploying: server/user/deploying.md
      - Monitoring: server/user/monitoring.md
      - Advanced: server/user/advanced.md
    - Developer Guide:
      - Setup: server/developer/setup.md
      - Testing: server/developer/testing.md
      - Debugging: server/developer/debugging.md
  - Synse SDK:
    - Introduction: sdk/intro.md
    - Architecture: sdk/architecture.md
    - Quickstart: sdk/quickstart.md
    - Configuration:
      - Plugin: sdk/configuration/plugin.md
      - Device: sdk/configuration/device.md
    - Concepts:
      - C Backend: sdk/concepts/c_backend.md
      - Command Line Arguments: sdk/concepts/command_line_arguments.md
      - Device Aliases: sdk/concepts/device_aliases.md
      - Device Handlers: sdk/concepts/device_handlers.md
      - Device IDs: sdk/concepts/device_ids.md
      - Device Tags: sdk/concepts/device_tags.md
      - Dynamic Registration: sdk/concepts/dynamic_registration.md
      - Plugin Actions: sdk/concepts/plugin_actions.md
      - Plugin Functions: sdk/concepts/plugin_functions.md
      - Plugin Health: sdk/concepts/plugin_health.md
      - Plugin Metadata: sdk/concepts/plugin_metadata.md
      - Plugin Metrics: sdk/concepts/plugin_metrics.md
      - Plugin Options: sdk/concepts/plugin_options.md
      - Reading Outputs: sdk/concepts/reading_outputs.md
      - Subscribing to Data Streams: sdk/concepts/subscribing_to_data.md
    - Tutorial: sdk/tutorial.md
    - FAQ: sdk/questions.md
    - Developer Guide:
      - Setup: sdk/developer/setup.md
      - Testing: sdk/developer/testing.md
  - Synse CLI:
    - Introduction: cli/intro.md
    - Usage: cli/usage.md


# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.attr_list
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.tables
  - markdown.extensions.toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: vapor-ware
      repo: synse-docs
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde