mkdocs.yml

site_name: Koinos Developer Hub
site_url: https://docs.koinos.io

site_description: Build a decentralized future with The World's First Feeless Smart Contract Platform. From running validators to smart contract development, Koinos Documentation has you covered.

repo_name: koinos
repo_url: https://github.com/koinos/koinos

edit_uri: https://github.com/koinos/koinos-docs/blob/master/docs/

copyright: Copyright 2023-2024 Koinos Group

docs_dir: docs
extra_css:
  - stylesheets/extra.css

theme:
  name: material
  language: en
  font:
    text: Plus Jakarta Sans
  palette:
    - media: "(prefers-color-scheme)"
      primary: black
      scheme: slate
      toggle:
        icon: material/link
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      primary: black
      scheme: default
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  icon:
    edit: material/pencil
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  favicon: assets/favicon.png
  logo: assets/koinos-logo-white.png

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/koinos
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/koinos/
    - icon: fontawesome/brands/discord
      link: https://discord.koinos.io
    - icon: fontawesome/brands/telegram
      link: https://telegram.koinos.io/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/koinosnetwork
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@koinosgroup

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - swagger-ui-tag
  - search

nav:
  - Home: index.md
  - Overview:
    - overview/index.md
    - overview/blockchain-basics.md
    - overview/mana.md
    - overview/proof-of-burn.md
    - overview/tokenomics.md
    - overview/smart-contracts.md
    - overview/governance.md
  - Developers:
    - developers/index.md
    - developers/cli.md
    - developers/as-sdk.md
    - developers/payer-payee.md
    - developers/rc-limits.md
    - developers/rest.md
    - developers/testnet.md
    - developers/resource-management.md
    - developers/deploy-contract.md
    - developers/protobuf.md
    - developers/transactions.md
    - developers/authority.md
    - Contract guides:
      - developers/guides/token.md
      - developers/guides/calculator.md
      - developers/guides/immutable.md
      - developers/guides/staking.md
      - developers/guides/authority.md
      - developers/guides/nft.md
  - Validators:
    - validators/index.md
    - validators/node-requirements.md
    - validators/docker-compose-profiles.md
    - validators/microservices.md
    - validators/configuration.md
    - validators/node-security.md
    - validators/node-management.md
    - Validator guides:
      - validators/guides/running-a-node.md
      - validators/guides/block-production.md
  - Exchanges:
    - exchanges/index.md
    - Technologies:
      - exchanges/cli.md
      - exchanges/koilib.md
      - exchanges/rest.md
    - Common tasks:
      - exchanges/head-block.md
      - exchanges/create-wallet.md
      - exchanges/account-balance.md
      - exchanges/transfer.md
      - exchanges/mana.md
      - exchanges/offline-signing.md
      - exchanges/multisig.md
      - exchanges/finality.md
      - exchanges/account-history.md
  - Architecture:
    - architecture/index.md
    - architecture/microservices.md
    - architecture/interprocess-communication.md
    - architecture/proof-of-burn.md
    - architecture/serialization.md
    - architecture/smart-contracts.md
    - architecture/contract-abi.md
    - architecture/resources.md
    - architecture/system-calls.md
  - Resources:
    - resources/index.md