mkdocs.yml

site_name: Taint Analysis Masterclass
site_description: Professional demonstration of taint analysis for application security
site_author: Laurent Giovannoni
site_url: ""  # Update when deploying to GitHub Pages

repo_name: laugiov/code-safety
repo_url: https://github.com/laugiov/code-safety
edit_uri: edit/main/docs/

copyright: Copyright © 2024 Laurent Giovannoni

docs_dir: docs
site_dir: site

theme:
  name: material
  language: en
  logo: assets/images/logo.svg
  favicon: assets/images/favicon.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true
      type: date

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - tables
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: docs
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/laugiov
      name: GitHub
  analytics:
    provider: google
    property: G-XXXXXXXXXX
  version:
    provider: mike
  generator: false

extra_css:
  - assets/css/custom.css

extra_javascript:
  - assets/js/custom.js

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Prerequisites: getting-started/prerequisites.md
  - Theory:
    - theory/index.md
    - Fundamentals: theory/fundamentals.md
    - Dataflow Analysis: theory/dataflow.md
    - Precision & Recall: theory/metrics.md
  - Tools:
    - tools/index.md
    - Comparison: tools/comparison.md
    - Pysa:
      - tools/pysa/index.md
      - Configuration: tools/pysa/configuration.md
      - Custom Models: tools/pysa/custom-models.md
      - Running Analysis: tools/pysa/running.md
    - CodeQL:
      - tools/codeql/index.md
      - Query Writing: tools/codeql/queries.md
      - Advanced Patterns: tools/codeql/advanced.md
      - Database Creation: tools/codeql/database.md
    - Semgrep:
      - tools/semgrep/index.md
      - Rule Writing: tools/semgrep/rules.md
      - Taint Mode: tools/semgrep/taint-mode.md
      - Quick Start: tools/semgrep/quickstart.md
  - Vulnerabilities:
    - vulnerabilities/index.md
    - SQL Injection: vulnerabilities/sql-injection.md
    - XSS: vulnerabilities/xss.md
    - Command Injection: vulnerabilities/command-injection.md
    - SSRF: vulnerabilities/ssrf.md
    - Deserialization: vulnerabilities/deserialization.md
    - Path Traversal: vulnerabilities/path-traversal.md
    - SSTI: vulnerabilities/ssti.md
    - XXE: vulnerabilities/xxe.md
  - VulnShop:
    - vulnshop/index.md
    - Overview: vulnshop/overview.md
    - Architecture: vulnshop/architecture.md
    - Vulnerability Map: vulnshop/vulnerability-map.md
    - Exploitation Guide: vulnshop/exploitation.md
  - Enterprise:
    - enterprise/index.md
    - CI/CD Integration: enterprise/ci-cd.md
    - False Positive Management: enterprise/false-positives.md
    - Scaling: enterprise/scaling.md
    - Governance: enterprise/governance.md
  - Benchmarks:
    - benchmarks/index.md
    - Methodology: benchmarks/methodology.md
    - Results: benchmarks/results.md
    - CVE Analysis: benchmarks/cve-analysis.md
    - Running Benchmarks: benchmarks/running.md

watch:
  - docs