mkdocs.yml

site_name: 'Witnet Protocol Documentation'
site_url: https://docs.witnet.io
copyright: © 2018-2019 The Witnet Community. Available under <a href="https://www.gnu.org/licenses/fdl-1.3.en.html" rel="license">GNU Free Documentation License v1.3</a>

nav:
  - Overview:
      - Ecosystem: index.md
      - What is Witnet?: overview/concepts.md
      - Software: overview/software.md
  - Quickstart:
      - Run a Node: try/run-a-node.md
      - Next Steps: try/next-steps.md
      #- Use the Sheikah wallet / IDE: try/sheikah.md
      - Connect your Ethereum contracts to external APIs: try/use-from-ethereum.md
  - Tutorial:
      - Introduction: tutorials/bitcoin-price-feed/introduction.md
      - 1. Create a new project: tutorials/bitcoin-price-feed/create-project.md
      - 2. Adding data sources: tutorials/bitcoin-price-feed/sources.md
      - 3. Define aggregator / tally: tutorials/bitcoin-price-feed/aggregations.md
      - 4. Fine-tune the request: tutorials/bitcoin-price-feed/fine-tuning.md
      - 5. Compile the request: tutorials/bitcoin-price-feed/compiling.md
      - 6. Write the Solidity contract: tutorials/bitcoin-price-feed/contract.md
      - 7. Deploy: tutorials/bitcoin-price-feed/migrations.md
      - Recap: tutorials/bitcoin-price-feed/recap.md
  - Community:
      - Roadmap: community/roadmap.md
  - Developer Docs:
      - Compile from source code: developer/from-source.md
      - Contributing: developer/contributing.md
      - Wallet API: developer/wallet-api.md
  - Protocol Docs:
      #- protocol/reputation.md
      - protocol/sortition.md
      #- protocol/transactions.md
      #- protocol/blocks.md
      - Witnet Requests:
          - Overview: protocol/data-requests/overview.md
          - Encoding: protocol/data-requests/radon-encoding.md
          - Examples: protocol/data-requests/examples.md
      #- protocol/serialization.md
  - Operator Docs:
      #- Run an Ethereum bridge: node-operators/ethereum-bridge.md
      #- Compilation: witnet-rust/compiling.md
      #- Configuration: witnet-rust/configuration.md
      - Hardware requirements: node-operators/hardware-requirements.md
      - Run as systemd service: node-operators/systemd-service.md
      - Run as docker-compose service: node-operators/docker-compose-service.md
      - Command Line Interface: node-operators/cli.md
      #- Witnet-Rust JSON-RPC: node-operators/json-rpc.md
      #- Wallet API: node-operators/wallet-api.md
  - More:
      - overview/glossary.md

theme:
  name: 'material'
  custom_dir: 'theme'
  favicon: 'assets/images/favicon.ico'
  logo: 'assets/images/logo.svg" alt="Witnet Logo'
  palette:
    primary: 'white'
    accent: 'deep-purple'

repo_name: 'witnet/documentation'
repo_url: 'https://github.com/witnet/documentation'
edit_uri: 'blob/master/docs'
remote_name: 'upstream'

extra:
  og_image: 'assets/images/logo-docs.png'
  social:
    - type: 'github'
      link: 'https://github.com/witnet'
    - type: 'reddit'
      link: 'https://reddit.com/r/witnet'
    - type: 'twitter'
      link: 'https://twitter.com/witnet_io'

extra_css:
  - 'extra.css'

extra_javascript:
  - 'extra.js'

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde