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.pegasys.tech/en/latest/
site_description: Teku Ethereum 2 client documentation.
site_author: Teku community
copyright: Teku 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.teku/
  latest_version_warning:
    url_contains: /latest/
    text: 'You are reading Teku 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/Teku
    email: support@pegasys.tech
    pegasys_website: https://pegasys.tech/
    issues: https://github.com/PegaSysEng/doc.teku/issues
  google:
    site_verification: '<TO BE DEFINED>'
    tag_manager: 'GTM-5SNB3FJ'
  search:
    language: 'en'
    tokenizer: '[\s]+'


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

theme:
  name: material
  custom_dir: common/custom_theme
  palette:
    primary: deep-orange
    accent: amber
  favicon: favicon.ico
  logo:
    icon: テク
nav:
    - How to:
        - Get started with Teku:
            - Install binary distribution: HowTo/Get-Started/Install-Binaries.md
            - Build from source: HowTo/Get-Started/Build-From-Source.md
            - Run Teku from Docker image: HowTo/Get-Started/Run-Docker-Image.md
            - Register validators: HowTo/Get-Started/Register-Validators.md
            - Run multiple Teku test nodes: HowTo/Get-Started/Start.md
            - Use an external signer: HowTo/Get-Started/Use-External-Signer.md
        - Monitor Nodes:
          - Use Metrics: HowTo/Monitor/Metrics.md
        - Configure:
            - Specify Options in a Configuration File: HowTo/Configure/Use-Configuration-File.md
    - Reference:
        - Teku Command Line:
          - Options: Reference/CLI/CLI-Syntax.md
          - Subcommands: Reference/CLI/CLI-Subcommands.md
        - RESTful APIs:
          - Teku REST API methods: Reference/Rest_API/Rest.md
          - Teku API objects: Reference/Rest_API/API-Objects.md

markdown_extensions:
  - toc:
      permalink: 
      toc_depth: 4
  - 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 is deprecated.
  # It must be replaced with pymdownx.tabbed but it requires new CSS
  # TODO with material 5 update
  - pymdownx.superfences:
      legacy_tab_classes: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - meta
  - smarty

plugins:
  - search
  - 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