mkdocs.yml

site_name: Nano Documentation
site_url: https://docs.nano.org/
theme:
  name: 'material'
  palette:
    - scheme: nano
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  font:
    text: 'Noto Sans'
    code: 'Roboto Mono'
  icon: 
    logo: 'nano'
    repo: 'fontawesome/brands/github'
  favicon: 'images/favicon.png'
  custom_dir: 'theme-overrides'
  features:
    - navigation.tabs
    - navigation.top
    - search.share
    - search.highlight
    - search.suggest
nav:
  - Home: index.md
  - What is Nano?: what-is-nano/overview.md
  - Living Whitepaper: what-is-nano/living-whitepaper.md
  - Running a Node:
    - Overview: running-a-node/overview.md
    - Security: running-a-node/security.md
    - Node Setup: running-a-node/node-setup.md
    - Docker Management: running-a-node/docker-management.md
    - Configuration: running-a-node/configuration.md
    - Ledger Management: running-a-node/ledger-management.md
    - Voting as a Representative: running-a-node/voting-as-a-representative.md
    - Advanced Monitoring: running-a-node/advanced-monitoring.md
    - Beta Network: running-a-node/beta-network.md
    - Test Network: running-a-node/test-network.md
    - Troubleshooting: running-a-node/troubleshooting.md
    - Beyond the Node: running-a-node/beyond-the-node.md
  - Integration Guides: 
    - The Basics: integration-guides/the-basics.md
    - Key Management: integration-guides/key-management.md
    - Block Confirmation Tracking: integration-guides/block-confirmation-tracking.md
    - Work Generation: integration-guides/work-generation.md
    - Build Options: integration-guides/build-options.md
    - WebSockets: integration-guides/websockets.md
    - IPC Integration: integration-guides/ipc-integration.md
    - Advanced: integration-guides/advanced.md
  - Commands:
    - RPC Protocol: commands/rpc-protocol.md
    - Command Line Interface: commands/command-line-interface.md
  - Protocol Design:
    - Introduction: protocol-design/introduction.md
    - Ledger: protocol-design/ledger.md
    - Blocks: protocol-design/blocks.md
    - Work: protocol-design/work.md
    - Networking: protocol-design/networking.md
    - ORV Consensus: protocol-design/orv-consensus.md
    - Attack Vectors: protocol-design/attack-vectors.md
    - Resource Usage: protocol-design/resource-usage.md
    - Distribution and Units: protocol-design/distribution-and-units.md
    - Signing, Hashing and Key Derivation: protocol-design/signing-hashing-and-key-derivation.md
    - Original whitepaper: whitepaper/english.md
  - Node Implementation:
    - Introduction: node-implementation/introduction.md
    - Components: node-implementation/components.md
    - Database: node-implementation/database.md
    - Blocks: node-implementation/blocks.md
    - Voting: node-implementation/voting.md
    - Work: node-implementation/work.md
    - Contributing: node-implementation/contributing.md
  - Releases:
    - Node Releases: releases/node-releases.md
    - Release Notes:
      - V22.0 (Latest): releases/release-v22-0.md
      - V21.3: releases/release-v21-3.md
      - V21.2: releases/release-v21-2.md
      - V21.1: releases/release-v21-1.md
      - V21.0: releases/release-v21-0.md
      - V20.0: releases/release-v20-0.md
      - V19.0: releases/release-v19-0.md
    - Network Upgrades: releases/network-upgrades.md
    - Roadmap: releases/roadmap.md
  - Glossary: glossary.md
markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
      toc_depth: 4
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tabbed
  - pymdownx.snippets:
      check_paths: true
      base_path: 'docs/snippets'
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - footnotes
  - pymdownx.striphtml:
      strip_comments: true
      strip_attributes: ''
  - meta
extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
  - 'https://unpkg.com/mermaid@8.4.8/dist/mermaid.min.js'
  - 'javascript/mermaid-loose-security.js'
extra_css:
  - 'stylesheets/extras.css'
extra:
  social:
  - icon: 'fontawesome/brands/github'
    link: 'https://github.com/nanocurrency'
  - icon: 'fontawesome/brands/twitter'
    link: 'https://twitter.com/nano'
  - icon: 'material/comment-multiple'
    link: 'https://chat.nano.org'
  - icon: 'fontawesome/brands/reddit'
    link: 'https://reddit.com/r/nanocurrency'
  - icon: 'fontawesome/brands/medium'
    link: 'https://medium.com/nanocurrency'
  - icon: 'fontawesome/brands/facebook'
    link: 'https://facebook.com/nanofoundation'
  - icon: 'fontawesome/brands/linkedin'
    link: 'https://linkedin.com/company/nano-foundation'
  - icon: 'fontawesome/brands/youtube'
    link: 'https://www.youtube.com/nanocurrency/'
  - icon: 'fontawesome/brands/instagram'
    link: 'https://www.instagram.com/nanocurrency/'
repo_name: 'nanocurrency/nano-docs'
repo_url: 'https://github.com/nanocurrency/nano-docs'
plugins:
    - search
    - redirects:
        redirect_maps:
            'running-a-node/rocksdb-ledger-backend.md': 'running-a-node/ledger-management.md'
            'protocol-design/network-attacks.md': 'protocol-design/attack-vectors.md'
            'what-is-nano/contributing.md': 'node-implementation/contributing.md'
            'what-is-nano/exploring-more.md': 'what-is-nano/overview.md'
            'releases/roadmap.md': 'https://github.com/orgs/nanocurrency/projects/5'
            'releases/upcoming-features.md': 'https://github.com/orgs/nanocurrency/projects/5'
            'releases/current-release-notes.md': 'releases/release-v22-0.md'