status-im
/
nimbus-eth2
mirror of https://github.com/status-im/nimbus-eth2.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book/mkdocs.yml

114 lines
2.3 KiB
YAML
Raw Normal View History

Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: The Nimbus Guide
theme:
name: material
features:
- navigation.expand
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- navigation.tabs
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- navigation.top
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- content.tabs.link
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
palette:
scheme: default
primary: orange
accent: amber
# 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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- meta
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- tables
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- toc:
toc_depth: 3
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
nav:
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- About:
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'index.md'
- 'merge.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'philosophy.md'
- 'preparation.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- Getting started:
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'quick-start.md'
- 'run-a-validator.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'migration.md'
- 'metrics-pretty-pictures.md'
- 'pi-guide.md'
- 'el-light-client.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- How-to:
- Beacon node:
- 'install.md'
- 'build.md'
- 'start-syncing.md'
- 'trusted-node-sync.md'
- 'web3-backup.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- Validator:
- 'deposit.md'
- 'keys.md'
- 'connect-eth2.md'
- 'graffiti.md'
- 'suggested-fee-recipient.md'
document external block builder configuration (#4032) * document external block builder configuration * Update docs/the_nimbus_book/src/external-block-builder.md Co-authored-by: Jacek Sieka <jacek@status.im> * unhide external payload builder options * clarify builder API incentive misalignment Co-authored-by: Jacek Sieka <jacek@status.im>
2022-08-29 09:59:12 +00:00
- 'external-block-builder.md'
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- 'keep-an-eye.md'
- 'voluntary-exit.md'
- 'more-keys.md'
- 'additional-validator.md'
- 'validator-client.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- General:
- 'keep-updated.md'
- 'eth1.md'
- 'goerli-eth.md'
- 'beacon-node-systemd.md'
- 'log-rotate.md'
- 'database-backup.md'
- 'email-notifications.md'
- 'profits.md'
- 'health.md'
- 'prater.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- Security:
- 'security_issues.md'
- 'audit.md'
- 'distribution_internals.md'
- Reference:
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'hardware.md'
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 20:13:47 +00:00
- 'options.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'networking.md'
- 'logging.md'
- 'validator-monitor.md'
- 'attestation-performance.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'rest-api.md'
- 'keymanager-api.md'
- 'data-dir.md'
- 'migration-options.md'
document LC data serving options (#3922) Adds a documentation page for configuring LC data serving.
2022-08-02 12:23:03 +00:00
- 'light-client-data.md'
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 19:47:24 +00:00
- 'troubleshooting.md'
- 'developers.md'
- 'resources.md'
- 'faq.md'
- 'api.md'
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 18:17:20 +00:00
- 'contribute.md'
- Downloads:
- 'binaries.md'
- 'docker.md'
- 'checksums.md'