mkdocs.yml

# Copyright 2020 ConsenSys Software Inc.
#
# 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.consensys.net/
site_description: Orion Transaction Manager documentation.
site_author: Orion community
copyright: Orion and its documentation are licensed under Apache 2.0 license.

#extra project info and template customisation
extra:
  logo_is_text: true
  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.'
  warning_banner: 'Orion features have been merged into Tessera!
  Read our <a href="https://docs.orion.consensys.net/en/latest/Tutorials/Migrating-from-Orion-to-Tessera/">Orion to Tessera migration guide</a>
  and about all <a href="https://consensys.net/blog/quorum/tessera-the-privacy-manager-of-choice-for-consensys-quorum-networks/">the new Tessera features</a>.'
  support:
    tool: Discord
    channel: https://discord.gg/n8m22JK
    email: quorum@consensys.net
    website: https://consensys.net/quorum/developers
    company: Consensys
    issues: https://github.com/ConsenSys/orion/issues
    faq: https://consensys.net/quorum/faq
  google:
    tag_manager: 'GTM-T5Q86JM'
    site_verification: 'za1cLzyS6LXDGO-pMzvfQdYTZ0Zc67uZtY0asA4YXZ0'
  inverted_logo: 'images/inverted_logo.svg'

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

theme:
  name: material
  custom_dir: common/custom_theme
  palette:
    primary: deep-purple
    accent: teal
  logo: 'images/logo.svg'
  favicon: 'images/favicon.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
        - Configure for high availability: HowTo/High-Availability.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
        - Migrating from Orion to Tessera: Tutorials/Migrating-from-Orion-to-Tessera.md
        - Quorum Developer Quickstart: Tutorials/Quorum-Dev-Quickstart.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
  - pymdownx.tabbed
  - pymdownx.superfences
  - 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.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - meta
  - smarty
  - attr_list
  - plantuml_markdown:
      server: http://www.plantuml.com/plantuml

plugins:
  - search:
      lang: 'en'
      separator: '[\s\-\.\_]+'
  - markdownextradata
  - exclude:
      glob:
        - global/*
  - git-revision-date-localized:
      locale: en
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
  - redirects:
      redirect_maps:
        # Configure redirects using key:value pairs:
        # old_path.md: new_path.md
        # you can't use an already redirected path as an old_path.
        # new_path can be a file inside the docs/ folder or any URL (http://...)
        Security/Responsible-Disclosure.md: Reference/Responsible-Disclosure.md
        Configuring-Orion/Disaster-Recovery.md: Concepts/Disaster-Recovery.md
        Configuring-Orion/TLS.md: Tutorials/TLS.md
        Configuring-Orion/Using-PostgreSQL.md: Tutorials/Using-PostgreSQL.md
        Configuring-Orion/Using-Oracle.md: Tutorials/Using-Oracle.md
        Configuring-Orion/Configuration-File.md: Reference/Configuration-File.md
        Using-Orion/Privacy-Groups.md: Concepts/Privacy-Groups.md
        Getting-Started/Quickstart.md: HowTo/Quickstart.md
        Installation/Build-From-Source.md: HowTo/Build-From-Source.md
        Installation/Install-Binaries.md: HowTo/Install-Binaries.md
        Installation/Dependencies.md: HowTo/Dependencies.md
        Installation/Overview.md: HowTo/Dependencies.md