mkdocs.yml

# Copyright 2018 ConsenSys AG.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

# Project information
site_name: Orion
site_url: https://docs.orion.pegasys.tech/en/latest/
site_description: Orion Transaction Manager documentation.
site_author: Orion community
copyright: Orion and its documentation are licensed under Apache 2.0 license /
  This <a href="https://readthedocs.org/">Readthedocs.org</a> documentation is maintained with love by <a href="https://pegasys.tech/">PegaSys</a>.

#extra project info and template customisation
extra:
  doc_site_edit_url: https://github.com/PegaSysEng/doc.orion/
  versions:
    stable: '1.3.2'
  latest_version_warning:
    url_contains: /latest/
    text: 'You are reading Orion development version documentation and
    some displayed features may not be available in the stable release.
    You can switch to stable version using the version box at screen bottom.'
  support:
    gitter: https://gitter.im/PegaSysEng/orion
    email: support@pegasys.tech
    pegasys_website: https://pegasys.tech/
    issues: https://pegasys1.atlassian.net/secure/Dashboard.jspa?selectPageId=10000
  google:
    tag_manager: 'GTM-T5Q86JM'
    site_verification: 'mB1S8j-y6oz3sfp36Q81dzMFyM7WEU5GHCImddGCqu8'
  search:
    language: 'en'
    tokenizer: '[\s]+'

# Repository
repo_name: PegaSysEng/orion
repo_url: https://github.com/PegaSysEng/orion

theme:
  name: material
  custom_dir: common/custom_theme
  palette:
    primary: deep-purple
    accent: teal
  favicon: favicon.ico
  logo: logo.svg
nav:
    - How to:
        - Get started with Orion:
            - Dependencies: HowTo/Dependencies.md
            - Install binary distribution: HowTo/Install-Binaries.md
            - Build from source: HowTo/Build-From-Source.md
            - Start Orion: HowTo/Quickstart.md
            - Run Orion from Docker Image: HowTo/Run-Docker-Image.md
    - Tutorials:
        - Using Oracle: Tutorials/Using-Oracle.md
        - Using PostgreSQL: Tutorials/Using-PostgreSQL.md
        - TLS: Tutorials/TLS.md
        - Generating Orion Certificates: Tutorials/Generating-Certificates.md
    - Concepts:
        - Privacy groups: Concepts/Privacy-Groups.md
        - Disaster recovery: Concepts/Disaster-Recovery.md
        - TLS Communication: Concepts/TLS-Communication.md
        - Multi-Tenancy: Concepts/Multi-Tenancy.md
    - Reference:
        - Orion command line: Reference/Orion-CLI-Syntax.md
        - Client API methods: Reference/API-Methods.md
        - Configuration file: Reference/Configuration-File.md
        - Responsible disclosure policy: Reference/Responsible-Disclosure.md

markdown_extensions:
  - toc:
      permalink: 
      toc_depth: 3
  - codehilite
  - markdown_include.include:
      base_path: docs
  - admonition
  - footnotes
  - def_list
  - abbr
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.keys
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - meta
  - smarty

plugins:
  - search
  - markdownextradata
  - exclude:
      glob:
        - global/*