#
# This file is distributed under the MIT License. See LICENSE.md for details.
#

site_name: rev.ng docs
docs_dir: share/doc/revng
theme:
  name: material
  palette:
    scheme: revng
  font:
    text: DM Sans
    code: DM Mono
  logo: assets/logo.svg
  features:
    - navigation.footer
    - content.code.copy
nav:
  - "What's rev.ng?": "what-is-revng.md"
  - "User's manual":
      - Introduction: "user-manual/index.md"
      - "Initial setup": "user-manual/initial-setup.md"
      - "Key concepts":
          - MetaAddress: "user-manual/key-concepts/metaaddress.md"
          - Model: "user-manual/key-concepts/model.md"
          - "Artifacts and analyses": "user-manual/key-concepts/artifacts-and-analyses.md"
      - Tutorial:
          - "A model from scratch": "user-manual/tutorial/model-from-scratch.md"
          - "Running analyses": "user-manual/tutorial/running-analyses.md"
      - "Python scripting": "user-manual/python-scripting.md"
  - "Developer's manual":
      - "QEMU helpers": "developer-manual/qemu-helpers.md"
  - "References":
      - "Model": references/model.md
      - Artifacts: references/artifacts.md
      - Analyses: references/analyses.md
      - CLI:
          - revng-common: references/cli/revng-common.md
          - revng-artifact: references/cli/revng-artifact.md
          - revng-analyze: references/cli/revng-analyze.md
          - revng2-project-artifact: references/cli/revng2-project-artifact.md
          - revng2-project-analyze: references/cli/revng2-project-analyze.md
      - "MIME types": references/mime-types.md
      - PTML: references/ptml.md
      - Pipeline: references/pipeline.md
markdown_extensions:
  - mkdocs_graphviz:
      color: cbd4da
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: "#"
  - admonition
  - pymdownx.details
extra_css:
  - stylesheets/main.css
  - stylesheets/theme.css
extra_javascript:
  - javascripts/additional.js
  - https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/mkdocs-graphviz.js