mkdocs.yml

# Project information
site_name: Quorum
site_url: https://docs.goquorum.com/
site_description: A permissioned implementation of Ethereum supporting data privacy
site_author: Quorum
copyright: Quorum 2019

# Repository
repo_name: quorum
repo_url: https://github.com/jpmorganchase/quorum

nav:
    - Getting Started:
        - Overview: Getting Started/Getting Started Overview.md
        - Installing: Getting Started/Installing.md
        - Examples: Getting Started/Quorum-Examples.md
        - Creating a Network From Scratch: Getting Started/Creating-A-Network-From-Scratch.md
        - Running Quorum: Getting Started/running.md
        - Quorum API: Getting Started/api.md
    - Consensus:
        - Consensus: Consensus/Consensus.md
        - Raft BFT:
            - Consensus/raft/raft.md
            - Consensus/raft/raft-rpc-api.md
        - Istanbul BFT:
            - Overview: Consensus/ibft/ibft.md
            - Consensus/ibft/istanbul-rpc-api.md
            - Consensus/ibft/ibft-parameters.md
    - Transaction Processing: Transaction Processing/Transaction Processing.md
    - Security Framework:
          - Overview: Security/Framework/Overview.md
          - Quorum Network:
            - Consortium: Security/Framework/Quorum Network Security/Consortium.md
            - Quorum Node:
                - Overview: Security/Framework/Quorum Network Security/Node.md
                - Permissioning:
                    - Network Permissioning: Security/Framework/Quorum Network Security/Nodes/Permissioning/Network Permissioning.md
            - Transaction Manager: Security/Framework/Quorum Network Security/Transaction Manager.md
            - Operational Considerations: Security/Framework/Quorum Network Security/Opertional Considerations.md
          - Decentralized App:
            - Frontend: Security/Framework/Decentralized Application/Frontend Components.md
            - Smart Contracts:  Security/Framework/Decentralized Application/Smart Contracts Security.md
    - Permissioning:
        - Overview: Permissioning/Overview.md
        - Design: Permissioning/Contract Design.md
        - Setup: Permissioning/setup.md
        - APIs: Permissioning/Permissioning apis.md
        - Usage: Permissioning/Usage.md
    - Privacy:
        - Tessera:
            - What is Tessera: Privacy/Tessera/Tessera.md
            - How Tessera works: Privacy/Tessera/How Tessera Works.md
            - Configuration:
                - Overview: Privacy/Tessera/Configuration/Configuration Overview.md
                - Keys Config: Privacy/Tessera/Configuration/Keys.md
                - TLS Config: Privacy/Tessera/Configuration/TLS.md
                - Using CLI to override config: Privacy/Tessera/Configuration/Using CLI to override config.md
                - Sample Configuration: Privacy/Tessera/Configuration/Sample Configuration.md
            - Tessera Services:
                - Transaction Manager: Privacy/Tessera/Tessera Services/Transaction Manager.md
                - Enclave: Privacy/Tessera/Tessera Services/Enclave.md
                - Keys:
                    - Key Generation: Privacy/Tessera/Tessera Services/Keys/Keys.md
                    - Setting up Hashicorp Vault: Privacy/Tessera/Tessera Services/Keys/Setting up a Hashicorp Vault.md
                    - Setting up Azure Key Vault: Privacy/Tessera/Tessera Services/Keys/Setting up an Azure Key Vault.md
                    - Setting up AWS Secrets Manager: Privacy/Tessera/Tessera Services/Keys/Setting up an AWS Secrets Manager.md
            - Usage:
                - Interfaces & API: Privacy/Tessera/Usage/Interface & API.md
                - Admin Usage: Privacy/Tessera/Usage/Admin Usage.md
                - Monitoring: Privacy/Tessera/Usage/Monitoring.md
            - Migration from Constellation: Privacy/Tessera/Migration from Constellation.md
        - Constellation:
            - What is Constellation: Privacy/Constellation/Constellation.md
            - How it works: Privacy/Constellation/How constellation works.md
            - Sample Configuration: Privacy/Constellation/Sample Configuration.md
            - Running Constellation: Privacy/Constellation/Installation & Running.md
    - Pluggable Architecture:
        - Overview: PluggableArchitecture/Overview.md
        - Settings: PluggableArchitecture/Settings.md
        - Internals: PluggableArchitecture/Internals.md
        - Plugins:
            - helloworld:
                - Interface: PluggableArchitecture/Plugins/helloworld/interface.md
                - Implementation: PluggableArchitecture/Plugins/helloworld/implementation.md
        - Plugin Development: PluggableArchitecture/PluginDevelopment.md
    - Cakeshop:
        - Overview: Cakeshop/Overview.md
        - Getting Started: Cakeshop/Getting started.md
        - Cakeshop FAQ: Cakeshop/Cakeshop FAQ.md
    - Remix Plugin:
        - Overview: RemixPlugin/Overview.md
        - Getting Started: RemixPlugin/Getting started.md
    - Quorum Features:
        - DNS: Features/dns.md
    - How-To Guides:
        - Adding new nodes: How-To-Guides/adding_nodes.md
        - Adding IBFT validators: How-To-Guides/add_ibft_validator.md
        - Backup & Restore: Features/import-export.md
    - Product Roadmap: roadmap.md
    - FAQ: FAQ.md

theme:
  name: 'material'
  custom_dir: 'docs/theme'
  font:
      text: 'Roboto'
      code: 'Roboto Mono'
  language: 'en'
  logo: 'images/logo.png'
  favicon: 'images/logo-48x48.png'

extra_css:
    - 'theme/assets/stylesheets/extra.css'

markdown_extensions:
    - toc:
        permalink: true
        toc_depth: 3
    - codehilite
    - admonition
    - footnotes
    - def_list
    - abbr
    - pymdownx.arithmatex
    - pymdownx.betterem:
          smart_enable: all
    - pymdownx.keys
    - pymdownx.details
    - pymdownx.emoji
    - pymdownx.magiclink
    - pymdownx.mark
    - pymdownx.smartsymbols
    - pymdownx.superfences
    - pymdownx.tasklist:
          custom_checkbox: true
    - pymdownx.tilde
    - markdown_include.include:
        base_path: docs
    - meta
    - smarty
    - plantuml_markdown:
        server: http://www.plantuml.com/plantuml

plugins:
    - search