zenith-docs/mkdocs.yml
2025-11-28 15:34:21 -05:00

102 lines
2.9 KiB
YAML

site_name: Zenith Documentation
site_description: Documentation for the Zenith blockchain ecosystem - bridging Urbit and blockchain consensus
site_url: https://zenith-docs.readthedocs.io
repo_url: https://github.com/Zenith-Foundation/zenith-docs
repo_name: Zenith-Foundation/zenith-docs
theme:
name: material
logo: assets/zenith-logo.png
favicon: assets/zenith-logo.png
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: light green
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
accent: light green
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.indexes
- navigation.top
- search.highlight
- search.share
- content.code.copy
- content.tabs.link
extra_javascript:
- https://unpkg.com/mermaid@10/dist/mermaid.min.js
nav:
- Home: index.md
- Overview:
- overview/index.md
- Introduction to Zenith: overview/introduction.md
- Lockdrop Onboarding: overview/lockdrop-onboarding.md
- Roles & Responsibilities: overview/roles-responsibilities.md
- Documentation:
- documentation/index.md
- Network Stages: documentation/network-stages.md
- Azimuth: documentation/azimuth.md
- Operator Deployments: documentation/deployments.md
- Ship Hosting: documentation/urbit-ship-hosting.md
- Janus Server: documentation/janus.md
- Scry Oracle: documentation/scry-oracle.md
- ePBS: documentation/epbs.md
- App Development: documentation/app-development.md
- Light Contracts: documentation/light-contracts.md
- Watchers: documentation/watchers.md
- Tokenomics: tokenomics/index.md
- API Reference:
- api/index.md
- Zenith Desk: api/zenith-desk-api.md
- zenithd: api/zenithd.md
- Janus: api/janus.md
- Azimuth Watcher: api/azimuth-watcher.md
- Lockdrop Watcher: api/lockdrop-watcher.md
- Zenith Watcher: api/zenith-watcher.md
- Command Reference:
- command-reference/index.md
- zenithd: command-reference/zenithd.md
- urbit: command-reference/urbit.md
- Glossary: glossary.md
- Public Infrastructure: public-infrastructure.md
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- attr_list
- md_in_html
- tables
- toc:
permalink: true
plugins:
- search
- git-revision-date-localized:
enable_creation_date: false