mirror of
https://github.com/AtHeartEngineering/lodestar.git
synced 2026-01-09 21:38:03 -05:00
6bd0310a96
* Remove architecture.md from docs * Update mkdocs.yml to remove architecture.md * Remove architecture link from readme * Remove architecture.md links from depgraph.md * Remove architecture overview from readme * Remove eth2 terminology on contributing.md * remove eth2 references from docs
81 lines
2.2 KiB
YAML
81 lines
2.2 KiB
YAML
site_name: Lodestar documentation
|
|
site_description: Lodestar documentation - Typescript Ethereum Consensus 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/lodestar_icon_300.png
|
|
favicon: assets/round-icon.ico
|
|
palette:
|
|
- scheme: preference
|
|
media: "(prefers-color-scheme: light)"
|
|
primary: black
|
|
accent: deep purple
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
media: "(prefers-color-scheme: dark)"
|
|
primary: black
|
|
accent: deep purple
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
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
|
|
- CLI 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
|
|
- Libraries: libraries/index.md
|
|
- Design:
|
|
- Lodestar package structure: design/depgraph.md
|
|
- Contributing: contributing.md
|