mkdocs.yml

site_name: Blockcore Documentation
site_url: https://docs.blockcore.net
site_description: Blockcore is a platform that enables you to build your own blockchains.
repo_name: documentation
repo_url: https://github.com/block-core/documentation
edit_uri: edit/master/docs/
site_author: Blockcore
copyright: Blockcore / MIT license

extra_javascript:
  - https://unpkg.com/mermaid@8.8.3/dist/mermaid.min.js
  - _mkdocs/extra_js/custom.js
extra_css:
  - _mkdocs/extra_css/custom.css

# change directory names here
docs_dir: docs
site_dir: ./docs_site

theme:
    logo: img/logo.png
    name: material
    custom_dir: docs/_mkdocs/overrides
    icon:
      repo: fontawesome/brands/github

    features:
      - content.code.annotate
      - navigation.indexes
      - navigation.sections
      - navigation.tabs
      - navigation.instant
      - navigation.top
      - navigation.tracking
      # - navigation.expand
      - search.highlight
      - search.share
      - search.suggest
      # - toc.integrate


    palette:
      # Light mode
      - media: "(prefers-color-scheme: light)"
        scheme: default
        primary: indigo
        accent: indigo
        logo: img/logo.png
        toggle:
          icon: material/weather-night
          name: Switch to dark mode

      # Dark mode
      - media: "(prefers-color-scheme: dark)"
        scheme: slate
        primary: deep purple
        accent: deep purple
        logo: img/logo-light.png
        toggle:
          icon: material/weather-sunny
          name: Switch to light mode


markdown_extensions:
  - abbr
  - def_list
  - attr_list #needed to use {:target="_blank"} on links
  - pymdownx.snippets:
      base_path: docs/_mkdocs/snippets
      check_paths: true
  - toc:
      permalink: false
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  #- meta
  - admonition
  - pymdownx.highlight:
      use_pygments: true
      linenums: true
      noclasses: false #set to true to enable pygments_style option
      pygments_style: 'vs'
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format

plugins:
  - search
  - git-revision-date
  - exclude-search:
      exclude:
        - _private/*.md
        - _snippets/*.*
        - extra_css/*.*
  #- section-index

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/block-core/documentation
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/blockcoredev
  generator: false
#  version:
#    provider: mike

nav:
  - index.md
  - Introduction:
    - introduction.md
    - Decentralization:
      - decentralization/social-media/social-media-platforms.md
      - Social Media R&D:
         - decentralization/social-media/research-and-design/reading-list.md
         - decentralization/social-media/research-and-design/readme.md
         - Consensus:
            - decentralization/social-media/research-and-design/consensus-algorithms/dPos.md
         - dApps:
            - decentralization/social-media/research-and-design/dApps/nostr.md
            - decentralization/social-media/research-and-design/dApps/stratis.cirrus.md
            - decentralization/social-media/research-and-design/dApps/taarafo.md
            - decentralization/social-media/research-and-design/dApps/x42.md
         - Data:
            - decentralization/social-media/research-and-design/data/readme.md
            - Architecture:
               - decentralization/social-media/research-and-design/data/architecture/strategy.md
            - Models:
               - decentralization/social-media/research-and-design/data/models/models.md
         - Identity:
            - decentralization/social-media/research-and-design/identity/self-sovereign.md
            - decentralization/social-media/research-and-design/identity/keri.md
         - Laws:
            - decentralization/social-media/research-and-design/laws/gdpr.md

  - Platform:
    - overview.md
    - usecases.md
    - Extension:
      - extension/index.md
      - extension/guide.md
      - extension/help.md
      - extension/installation.md
    - referencenodes.md
    - walkthrough.md
    - Explorer:
      - explorer/index.md
      - explorer/indexer.md
      - explorer/website.md
      - explorer/dns.md
    - Cold Staking:
      - coldstaking/index.md
      - coldstaking/coldstake.md
      - coldstaking/coldstake-cloud.md
      - coldstaking/coldstake-pool.md
  - Architecture:
    - architecture.md
    - release-process.md
  - Node:
    - Features:
      -  node/features/index.md
      -  node/features/airdrop.md
      -  node/features/blockstore.md
      -  node/features/blockexplorer.md
      -  node/features/coldstaking.md
      -  node/features/consensus.md
      -  node/features/diagnostics.md
      -  node/features/dns.md
      -  node/features/memorypool.md
      -  node/features/miner.md
      -  node/features/nodehost.md
      -  node/features/notifications.md
      -  node/features/poa.md
      -  node/features/rpc.md
      -  node/features/storage.md
      -  node/features/wallet.md
      -  node/features/walletwatchonly.md
      -  node/features/walletnotify.md
    - API:
      -  node/api/index.md
      -  node/api/apiauthentication.md
      -  node/api/apiauthorization.md
    - P2P:
      -  node/p2p/index.md
      -  node/p2p/payloads.md

  - Community and Support:
    - FAQ:
      - faq/index.md
      - faq/faq-general.md
      - faq/faq-deployment.md
      - faq/faq-synchronization.md
      - faq/faq-integrations.md
      - faq/faq-wallet.md
    -  support.md
    -  contribute.md
    -  signingcommits.md
    -  securityissues.md
    -  development.md
    -  community.md
  # - Example Projects:
  #     - example-projects/index.md
  #     - example-projects/mithril-shards-example.md
  #     - example-projects/mithril-shards-example-network-bedrock.md
  #     - example-projects/mithril-shards-example-dev.md
  #     - example-projects/mithril-shards-example-node.md
  #     - example-projects/running-example.md
  - links.md