136 lines
3.2 KiB
YAML
136 lines
3.2 KiB
YAML
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
|
|
|
|
# nimbus_guide
|
|
# Copyright (c) 2022-2024 Status Research & Development GmbH
|
|
# Licensed and distributed under either of
|
|
# * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT).
|
|
# * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0).
|
|
# at your option. This file may not be copied, modified, or distributed except according to those terms.
|
|
|
|
site_name: The Nimbus Guide
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.expand
|
|
- navigation.tabs
|
|
- navigation.top
|
|
- content.tabs.link
|
|
palette:
|
|
- scheme: slate
|
|
primary: black
|
|
accent: light blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
- scheme: default
|
|
primary: white
|
|
accent: light blue
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
# Support urls previously used by mdbook
|
|
use_directory_urls: false
|
|
repo_url: https://github.com/status-im/nimbus-eth2
|
|
edit_uri: edit/unstable/docs/the_nimbus_book/src
|
|
site_url: https://nimbus.guide
|
|
docs_dir: src
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- toc:
|
|
toc_depth: 3
|
|
|
|
nav:
|
|
- Home:
|
|
- 'index.md'
|
|
|
|
- Getting started:
|
|
- 'quick-start.md'
|
|
- 'run-a-validator.md'
|
|
- 'el-light-client.md'
|
|
- 'execution-client.md'
|
|
- 'pi-guide.md'
|
|
|
|
- How-to:
|
|
- Beacon node:
|
|
- 'install.md'
|
|
- 'build.md'
|
|
- 'start-syncing.md'
|
|
- 'trusted-node-sync.md'
|
|
- 'migration.md'
|
|
|
|
- Validator:
|
|
- 'graffiti.md'
|
|
- 'suggested-fee-recipient.md'
|
|
- 'external-block-builder.md'
|
|
- 'keep-an-eye.md'
|
|
- 'more-keys.md'
|
|
- 'additional-validator.md'
|
|
- 'validator-client.md'
|
|
- 'withdrawals.md'
|
|
- 'voluntary-exit.md'
|
|
|
|
- General:
|
|
- 'keep-updated.md'
|
|
- 'eth1.md'
|
|
- 'goerli-eth.md'
|
|
- 'beacon-node-systemd.md'
|
|
- 'log-rotate.md'
|
|
- 'metrics-pretty-pictures.md'
|
|
- 'database-backup.md'
|
|
- 'email-notifications.md'
|
|
- 'profits.md'
|
|
- 'health.md'
|
|
- 'holesky.md'
|
|
|
|
- Security:
|
|
- 'preparation.md'
|
|
- 'security_issues.md'
|
|
- 'audit.md'
|
|
- 'distribution_internals.md'
|
|
|
|
- Reference:
|
|
- 'faq.md'
|
|
- 'hardware.md'
|
|
- Advanced options:
|
|
- 'options.md'
|
|
- 'networking.md'
|
|
- 'optimistic-sync.md'
|
|
- 'light-client-data.md'
|
|
- 'logging.md'
|
|
- 'validator-client-options.md'
|
|
- 'validator-monitor.md'
|
|
- 'doppelganger-detection.md'
|
|
- "REST APIs":
|
|
- 'rest-api.md'
|
|
- 'keymanager-api.md'
|
|
- Storage:
|
|
- 'data-dir.md'
|
|
- 'era-store.md'
|
|
- 'history.md'
|
|
- 'web3signer.md'
|
|
- 'migration-options.md'
|
|
- 'attestation-performance.md'
|
|
- 'troubleshooting.md'
|
|
- 'developers.md'
|
|
- 'resources.md'
|
|
- 'contribute.md'
|
|
|
|
- Downloads:
|
|
- 'binaries.md'
|
|
- 'docker.md'
|
|
- 'checksums.md'
|