mkdocs.yml

# Copyright 2019 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: Teku
site_url: https://docs.teku.consensys.net/
site_description: Teku Ethereum 2 client documentation.
site_author: Teku community
copyright: Teku and its documentation are licensed under Apache 2.0 license.

#extra project info and template customisation
extra:
  latest_version_warning:
    url_contains: /latest/
    text: 'You are reading the Teku development version documentation and
    some features may not be available in the stable release.
    You can switch to the stable version using the version box at the bottom of the screen.'
  support:
    tool: Discord
    channel: https://discord.gg/9mCVSY6
    email: quorum@consensys.net
    website: https://consensys.net/knowledge-base/ethereum-2/teku
    company: Consensys
    issues: https://github.com/Consensys/teku/issues
  google:
    site_verification: 'za1cLzyS6LXDGO-pMzvfQdYTZ0Zc67uZtY0asA4YXZ0'
    tag_manager: 'GTM-5SNB3FJ'
  search:
    language: 'en'
    tokenizer: '[\s]+'


# Software Repository
repo_name: Consensys/Teku
repo_url: https://github.com/Consensys/teku

theme:
  name: material
  custom_dir: common/custom_theme
  palette:
    primary: deep-orange
    accent: amber
  logo: 'images/logo.svg'
  favicon: 'images/favicon.svg'
nav:
    - How to:
        - Get started with Teku:
            - Install Teku:
                - Install binary distribution: HowTo/Get-Started/Installation-Options/Install-Binaries.md
                - Build from source: HowTo/Get-Started/Installation-Options/Build-From-Source.md
                - Run Teku from Docker image: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
            - Start Teku: HowTo/Get-Started/Run-Teku.md
            - Manage memory: HowTo/Get-Started/Manage-Memory.md
            - Connect to a network:
                - Connect to Mainnet: HowTo/Get-Started/Connect/Connect-To-Mainnet.md
                - Connect to a testnet: HowTo/Get-Started/Connect/Connect-To-Testnet.md
            - Start Teku from a recent state: HowTo/Get-Started/Checkpoint-Start.md
            - Migrate to Teku: HowTo/Get-Started/Migrate-to-Teku.md
        - External signing:
              - Use an external signer: HowTo/External-Signer/Use-External-Signer.md
              - Manage validator signing keys: HowTo/External-Signer/Manage-keys.md
        - Load validators without restarting: HowTo/Load-Validators-No-Restart.md
        - Monitor nodes:
          - Use metrics: HowTo/Monitor/Metrics.md
          - Configure logging: HowTo/Monitor/Logging.md
        - Configure:
            - Specify options in a configuration file: HowTo/Configure/Use-Configuration-File.md
            - Configure TLS: HowTo/Configure/Configure-TLS.md
        - Prevent slashing offences: HowTo/Prevent-Slashing.md
        - Find and connect to peers:
            - Improve P2P connectivity: HowTo/Find-and-Connect/Improve-Connectivity.md
            - Specify NAT methods: HowTo/Find-and-Connect/Specifying-NAT.md
        - Voluntary exit: HowTo/Voluntary-Exit.md
        - Migrate database: HowTo/Migrate-Database.md
        - Prepare for The Merge: HowTo/Prepare-for-The-Merge.md
        - Troubleshoot:
            - Solve common problems: HowTo/Troubleshoot/Troubleshooting.md
    - Concepts:
        - Architecture: Concepts/ArchitectureOverview.md
        - Proof of stake: Concepts/Proof-of-Stake.md
        - The Merge: Concepts/Merge.md
        - Node private key: Concepts/P2P-Private-Key.md
        - Slashing protection: Concepts/Slashing-Protection.md
        - Weak subjectivity: Concepts/Weak-Subjectivity.md
    - Tutorials:
        - External signer TLS: Tutorials/Configure-External-Signer-TLS.md  
    - Reference:
        - Teku command line:
          - Options: Reference/CLI/CLI-Syntax.md
          - Subcommands:
            - Overview: Reference/CLI/Subcommands/Subcommands.md
            - admin: Reference/CLI/Subcommands/Admin.md
            - migrate-database: Reference/CLI/Subcommands/Migrate-Database.md
            - slashing-protection: Reference/CLI/Subcommands/Slashing-Protection.md
            - validator-client, vc: Reference/CLI/Subcommands/Validator-Client.md
            - voluntary-exit: Reference/CLI/Subcommands/Voluntary-Exit.md
            - Development and testing: Reference/CLI/Subcommands/Development.md
        - RESTful APIs:
          - Teku REST API methods: Reference/Rest_API/Rest.md

markdown_extensions:
  - toc:
      permalink: 
      toc_depth: 4
  - 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

plugins:
  - search:
      lang: 'en'
      separator: '[\s]+'
  - markdownextradata
  - git-revision-date-localized:
      locale: en
  - 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://...)
        # Reference/Teku-CLI.md: Reference/CLI/CLI-Syntax.md
        HowTo/Get-Started/Build-From-Source.md: HowTo/Get-Started/Installation-Options/Build-From-Source.md
        HowTo/Get-Started/Install-Binaries.md: HowTo/Get-Started/Installation-Options/Install-Binaries.md
        HowTo/Get-Started/Run-Docker-Image.md: HowTo/Get-Started/Installation-Options/Run-Docker-Image.md
        HowTo/Get-Started/Connect-To-Testnet.md: HowTo/Get-Started/Connect/Connect-To-Testnet.md
        Reference/Rest_API/API-Objects.md: Reference/Rest_API/Rest.md