mkdocs.yml

site_name: Risk Based Prioritization
site_url: https://github.com/RiskBasedPrioritization/RiskBasedPrioritization.github.io

# Page tree
nav:
  - Home: index.md
  - Introduction: 
    - Foreword: introduction/foreword.md
    - Preface: introduction/preface.md
    - Introduction: introduction/Introduction.md
    - Contributors: introduction/contributors.md
    - Scope: introduction/Scope.md
    - Source Code and Data: introduction/code_and_data.md
  - Risk: 
    - Vulnerability Landscape: risk/Vulnerability_Landscape.md
    - Understanding Risk: risk/Understanding_Risk.md
    - Likelihood of Exploitation Populations: risk/Data_Sources.md
    - Applied Back of Napkin Risk Prioritization: risk/Back_of_napkin.md
  - Standards:
    - Common Vulnerability Scoring System (CVSS): cvss/CVSS.md
    - CISA Known Exploited Vulnerabilities (CISA KEV): cisa_kev/cisa_kev.md
    - Exploit Prediction Scoring System (EPSS):
      - Exploit Prediction Scoring System (EPSS): epss/Introduction_to_EPSS.md
      - Applying EPSS to your environment: epss/Applying_EPSS_to_your_environment.md
      - EPSS and CISA Known Exploited Vulnerabilities (CISA KEV): epss/EPSS_and_CISA_KEV.md
      - What Users Ask For: epss/What_users_ask_for.md
      - EPSS Thresholds: epss/EPSS_Thresholds.md
      - Grouped EPSS: epss/grouped_epss.md
    - NIST LEV: 
      - NIST LEV: epss/LEV.md      
    - Stakeholder-Specific Vulnerability Categorization (SSVC): 
      - Stakeholder-Specific Vulnerability Categorization (SSVC): ssvc/SSVC.md
      - Decision Trees From Scratch: ssvc/decision_trees_from_scratch.md
      - Decision Trees Example Usage: ssvc/decision_trees.md
    - Applied Log4Shell Example: risk/Log4Shell.md
  - Related Standards:
    - Common Weakness and Enumeration (CWE):
      - CWE: cwe/cwe.md
      - CWE Relationships: cwe/cwe_abstraction.md
      - CWE Views: cwe/cwe_views.md
      - CWE Counts: cwe/cwe_counts.md      
      - CWE 1000:
        - CWE 1000: cwe/cwe_1000.md
        - CWE 1000 Sunburst: cwe/sunburst.md
      - Impact:
        - Impact: impact/impact.md
  - Vendors: 
    - Vendors: vendors/vendors.md
    - Qualys: vendors/Qualys.md
    - EdgeScan: vendors/Edgescan.md
    - Microsoft Exploitability Index: vendors/Microsoft_Exploitability_Index.md
  - Organizations: 
    - Yahoo: organizations/Yahoo.md
    - ACME Inc: organizations/acme/Applied.md
  - Takeaway:
    - Risk Based Prioritization Schemes: risk/Rbp_schemes.md
    - Takeaway: risk/Takeaway.md
  - Annex:
    - Talks & Research: talks/talks.md
    - Requirements: requirements/Requirements.md
    - Glossary: annex/Glossary.md
  
    

theme:
  name: material


  custom_dir: docs/overrides
  icon:
    logo: material/fire-off
  features:
    - navigation.expand
    - navigation.footer
    ##- navigation.indexes
    ##- navigation.instant
    ###- navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    #- navigation.sections
    ##- navigation.tabs
    # - navigation.tabs.sticky
    ##- navigation.top
    ##- navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    #- toc.follow
    # - toc.integrate
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline 
        name: Switch to dark mode
        primary: light blue
      accent: purple 
    - scheme: slate 
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode    
      primary: teal
      accent: lime
markdown_extensions:
  - pymdownx.snippets:
      auto_append: [includes/abbreviations.md]
      base_path: docs
  - abbr
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink # to hyperlink all urls
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - md_in_html
  - tables
  - markdown_include.include:
      base_path: docs
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true



extra_css:
  - stylesheets/extra.css
  - stylesheets/cwe_sunburst.css
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js # for sortable tables
  - javascripts/tablesort.js 
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js #https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax-mkdocsyml
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js #https://squidfunk.github.io/mkdocs-material/reference/math/#mathjax-mkdocsyml
  # include D3 from CDN, then your custom JS & CSS
  - https://cdnjs.cloudflare.com/ajax/libs/d3/7.8.5/d3.min.js
  - assets/js/cwe_sunburst.js



watch:
  - docs/includes
  - docs

extra:
  analytics:
    provider: google
    property: G-51FVYR35TJ
  social:
  - icon: fontawesome/solid/house
    link: https://github.com/RiskBasedPrioritization/RiskBasedPrioritization.github.io
    name: Risk Based Prioritization Guide
  - icon: fontawesome/solid/bug
    link: https://github.com/RiskBasedPrioritization/RiskBasedPrioritization.github.io/issues/
    name: Report an Issue or Suggest a Change
  - icon: fontawesome/brands/github
    link: https://github.com/RiskBasedPrioritization/RiskBasedPrioritization.github.io
    name: Risk Based Prioritization source on Github
  - icon: fontawesome/solid/download
    link: https://riskbasedprioritization.github.io/print_page/
    name: Save as HTML or print to PDF / paper

copyright: Copyright © Contributors to the Risk Based Prioritization Guide.

plugins:
  - search
  - print-site