mkdocs.yml

site_name: Decred Developer Documentation
site_url: https://devdocs.decred.org
use_directory_urls: true
validation:
  # Increase severity of validation rules to trigger build failures on common mistakes.
  absolute_links: warn
  unrecognized_links: warn
  nav:
    omitted_files: warn
    absolute_links: warn
watch:
  - "docs"
theme:
  name: material
  favicon: 'img/favicon.ico?v=s3ss'
  logo: 'img/decred_logo_symbol_128.svg'
  font: false
  features:
    - navigation.instant
  icon:
    repo: octicons/mark-github-16
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: dcrdocs-light
      # Primary and accent colours should be fully overridden by dcrdocs-light theme.
      # If any green shows up in the site, thats a bug.
      primary: green
      accent: green
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: dcrdocs-dark
      # Primary and accent colours should be fully overridden by dcrdocs-dark theme.
      # If any green shows up in the site, thats a bug.
      primary: green
      accent: green
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
extra:
  social:
    - icon: octicons/mark-github-16
      link: https://github.com/decred
      name: GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/decredproject
      name: Twitter
    - icon: fontawesome/brands/medium
      link: https://medium.com/decred
      name: Medium
    - icon: fontawesome/brands/reddit
      link: https://www.reddit.com/r/decred/
      name: Reddit
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/decredchannel
      name: YouTube
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/decredproject/
      name: LinkedIn
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/decredproject/
      name: Facebook
    - icon: fontawesome/brands/weibo
      link: https://weibo.com/DecredProject
      name: Weibo
repo_url: https://github.com/decred/dcrdevdocs
repo_name: decred/dcrdevdocs
markdown_extensions:
  - footnotes
  - smarty
  - admonition
  - toc
  - tables
  - attr_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
  - css/fonts.css
  - css/style.css
plugins:
  - markdownextradata
  - search
  - social:
      enabled: !ENV [DCRDEVDOCS_CARDS, false]
      cards_layout_options:
        font_family: 'Source Sans 3'
        background_color: '#091440'
        color: '#FFFFFF'
nav:
- 'Home': 'index.md'
- 'Projects': 'projects.md'
- Core Blockchain Concepts:
  - 'Blockchain': 'core-blockchain-concepts/blockchain.md'
  - Proof-of-Stake (PoS):
    - 'Stake Enabled Height (SEH)': 'core-blockchain-concepts/proof-of-stake/stake-enabled-height.md'
    - 'Stake Validation Height (SVH)': 'core-blockchain-concepts/proof-of-stake/stake-validation-height.md'
- Developer Guides:
  - Transactions:
    - 'Transactions': 'developer-guides/transactions/transactions.md'
    - 'Transaction Format': 'developer-guides/transactions/transaction-format.md' 
    - 'Transaction Extensions': 'developer-guides/transactions/transaction-extensions.md'
    - txscript:
      - "Overview": 'developer-guides/transactions/txscript/overview.md'
      - "Opcodes": 'developer-guides/transactions/txscript/opcodes.md'
  - Wallets:
    - 'Overview': 'developer-guides/wallets/overview.md'
    - 'Seed Generation Process': 'developer-guides/wallets/mnemonic-seed.md'
    - 'Deterministic Wallet Formats': 'developer-guides/wallets/deterministic-wallet-formats.md'
  - 'Addresses': 'developer-guides/addresses.md'
  - 'Blockchain Parameters': 'developer-guides/blockchain-parameters.md'
  - 'Block Header Specifications': 'developer-guides/block-header-specifications.md'
  - 'Script Extensions': 'developer-guides/script-extensions.md'
  - 'Merkle Root Construction': 'developer-guides/merkle-root-construction.md'
  - 'Ticket Selection': 'developer-guides/ticket-selection.md'
  - 'Reproducible Builds': 'developer-guides/reproducible-builds.md'
- Protocol / Peer-to-Peer (P2P) Network:
  - 'Peer Discovery': 'protocol-p2p-network/peer-discovery.md'
  - 'Initial Block Download': 'protocol-p2p-network/initial-block-download.md'
  - 'Orphan Blocks': 'protocol-p2p-network/orphan-blocks.md'
  - 'Transaction Broadcasting': 'protocol-p2p-network/transaction-broadcasting.md'
  - 'Memory Pool': 'protocol-p2p-network/memory-pool.md'
- Environments:
  - 'Mainnet': 'environments/mainnet.md'
  - 'Testnet': 'environments/testnet.md'
  - 'Simnet': 'environments/simnet.md'
  - 'Regnet': 'environments/regnet.md'
- Contributing:
  - 'Contributor Guidelines': 'contributing/contributor-guidelines.md'
copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdevdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdevdocs/compare">send a pull request</a>.<br />dcrdevdocs v0.0.1. Decred Project 2020-2024.