mkdocs.yml

site_name: Kubernetes Builder
site_description: Kubernetes external chaincode builder for Hyperledger Fabric
repo_name: fabric-builder-k8s
repo_url: https://github.com/hyperledger-labs/fabric-builder-k8s
docs_dir: docs
theme:
  name: material
  logo: assets/Hyperledger_Fabric_White.svg
  favicon: assets/Hyperledger_Fabric_Icon.svg
  icon:
    repo: fontawesome/brands/github
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
  - content.code.copy
  - navigation.expand
  - navigation.footer
  - navigation.instant
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - toc.follow
  - toc.integrate
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
plugins:
  - search
  - mike
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/hyperledger
      name: Hyperledger Discord
nav:
  - About:
    - Introduction: index.md
    - Objectives: about/objectives.md
    - Community: about/community.md
  - Getting Started:
    - Quick Start: getting-started/demo.md
    - Requirements: getting-started/requirements.md
    - Installation: getting-started/install.md
    - FAQs: getting-started/faqs.md
  - Concepts:
    - Chaincode builder: concepts/chaincode-builder.md
    - Chaincode image: concepts/chaincode-image.md
    - Chaincode package: concepts/chaincode-package.md
  - Configuring:
    - Configuration overview: configuring/overview.md
    - Kubernetes permissions: configuring/kubernetes-permissions.md
    - Kubernetes namespace: configuring/kubernetes-namespace.md
    - Kubernetes service account: configuring/kubernetes-service-account.md
  - Tutorials:
    - Developing and debuging chaincode: tutorials/develop-chaincode.md
    - Creating a chaincode package: tutorials/package-chaincode.md