mkdocs.yaml

site_name: Detection Replay Framework
site_url: https://vectra-ai-research.github.io/derf/
repo_url: https://github.com/vectra-ai-research/derf
repo_name: DeRF
plugins:
  - search
  - awesome-pages
  - glightbox
theme:
  name: material
  logo: 
  favicon: 
  palette:
    - scheme: default
      primary: green
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: green
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
  - navigation.expand
  - navigation.indexes
  - navigation.top
  - navigation.tabs
  - navigation.tabs.sticky
  - content.code.copy
  - content.code.annotate
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
use_directory_urls: true
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tasklist:
      custom_checkbox: false
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde      
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.magiclink
  - tables
  - meta
  - abbr
  - def_list
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true 


extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tablesort.js
extra_css:
  - css/extra.css
  - css/w3.css

extra:
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/nightmareJS
copyright: 


nav:
  - DeRF:
      - index.md
      - Frequently Asked Questions: faq.md
      - DeRF vs. Other Tools: comparison.md
      - Contributing: contributing.md
  - Deployment:
      - DeRF Deployment: Deployment/derf-deployment.md  
      - Deployment Permissions: Deployment/deployment-permissions.md
  - User Guide:
      - Getting Started: user-guide/getting-started.md
      - Executing An Attack: user-guide/usage.md
      - Programmatic Execution: user-guide/programmatic-usage.md
      - DeRF User Permissions: user-guide/execution-user-permissions.md
      - Troubleshooting: user-guide/troubleshooting.md  
      - AWS Attack Creation: user-guide/aws-attack-creation.md        
  - Attack Techniques Reference:
      - All Attack Techniques: attack-techniques/list.md
      - ... | attack-techniques/*/*.md