mkdocs.yml

---
site_name: Revizor
site_url: https://github.com/microsoft/sca-fuzzer
site_author: Microsoft
site_description: A security-oriented tool for detecting microarchitectural leaks in CPUs, such as Spectre and Meltdown.
copyright: 'Copyright © 2024 Microsoft'

repo_name: microsoft/sca-fuzzer
repo_url: https://github.com/microsoft/sca-fuzzer

theme:
  name: material
  custom_dir: mkdocs-overrides
  logo: assets/ms_icon.png
  favicon: assets/ms_icon.png
  palette:
    primary: indigo
  features:
    - navigation.instant
    - navigation.tabs
    - search.share

plugins:
  - search

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - meta
  - admonition
  - pymdownx.highlight
  - pymdownx.pathconverter
  - pymdownx.tabbed
  - pymdownx.tasklist

nav:
  - Home: index.md
  - Quick Start: quick-start.md
  - User Documentation:
    - Command Line Interface: cli.md
    - Configuration Options: config.md
    - Fuzzing Guide: fuzzing-guide.md
    - Minimization Passes: minimization.md
  - Developer Documentation:
    - Developer Guide: development.md
    - How Revizor Works: how-revizor-works.md
    - Architecture Overview: architecture.md
    - Executor-related Topics:
      - Register Allocation: registers.md
      - Memory Layout: sandbox.md
  # - Trophies: trophies.md