mkdocs.yml

site_name: Lodestar documentation
site_description: Lodestar documentation - Typescript Eth2.0 client
site_url: https://chainsafe.github.io/lodestar

repo_name: chainsafe/lodestar
repo_url: https://github.com/chainsafe/lodestar

# Configuration
theme:
  name: material
  logo: assets/300ppi/short-LS-hookS-WHITE.png
  favicon: images/favicon.ico
  palette:
    scheme: preference
    accent: black
  nav_style: dark

plugins:
  - search
  - mermaid2:
      version: 8.6.4
      arguments:
        theme: |
          ^(window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'

markdown_extensions:
  - meta
  - codehilite:
      guess_lang: false
  - admonition
  - toc:
      permalink: true
  - pymdownx.superfences:
      # make exceptions to highlighting of code (for mermaid):
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
extra_css:
  - stylesheets/extras.css

# Socials
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/ChainSafe/lodestar
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ChainSafe
    - icon: fontawesome/brands/discord
      link: https://discord.gg/yjyvFRP
    - icon: fontawesome/brands/medium
      link: https://medium.com/ChainSafe

# Customize left navigation menu
nav:
  - Getting started: index.md
  - Installation: installation.md
  - Design:
      - Beacon node architecture: design/architecture.md
      - Beacon node events: design/events.md
      - Lodestar package structure: design/depgraph.md
  - Usage:
      - Mainnet or public testnet: usage/testnet.md
      - Local testnet: usage/local.md
      - Key management: usage/key-management.md
      - Prometheus & Grafana Setup: usage/prometheus-grafana.md
  - Reference:
      - Command line: reference/cli.md
  - Packages: packages.md
  - Contributing: contributing.md