agentic_security/mkdocs.yml at main · CodeBeaverAI/agentic_security · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
site_name: Agentic Security
repo_url: https://github.com/msoedov/agentic_security
site_url: https://msoedov.github.io/agentic_security
site_description: Open-source LLM Vulnerability Scanner for safe and reliable AI.
site_author: Agentic Security Team
edit_uri: edit/main/docs/
repo_name: msoedov/agentic_security
copyright: Maintained by <a href="https://msoedov.github.io">Agentic Security Team</a>.

nav:
  - Adventure starts here:
      - Overview: index.md
      - Quickstart: quickstart.md
      - Design: design.md
      - Abstractions: abstractions.md
  - Features: probe_data.md
  - Concepts:
    - Probe Actor: probe_actor.md
    - Refusal Actor: refusal_classifier_plugins.md
    - Agent Spec: http_spec.md
  - Setup:
    - Installation: installation.md
    - Getting Started: getting_started.md
    - Configuration: configuration.md
  - Advanced Topics:
    - Dataset Extension: datasets.md
    - External Modules: external_module.md
    - CI/CD Integration: ci_cd.md
    - Bayesian Optimization: optimizer.md
    - Image Generation: image_generation.md
    - Stenography Functions: stenography.md
    - Reinforcement Learning Optimization: rl_model.md
  - WIP:
    - Agent Operator: operator.md
  - Reference:
    - API Reference: api_reference.md
  # - Project:
  #     - Setup: setup.md
  #     - Version control: version_control.md
  #     - Docker: docker.md
  #     - Variables: variables.md
  #     - Custom libraries: custom_libraries.md
  #     - Database: database.md
  #     - Credentials: credentials.md
  #     - Code execution: code_execution.md
  #     - Settings: settings.md
  #     - Version upgrades: version_upgrades.md
  # - Contributing:
  #     - Overview: contributing_overview.md
  #     - Dev environment: dev_environment.md
  #     - Backend: backend.md
  #     - Frontend: frontend.md
  #     - Documentation: documentation.md
  # - About:
  #     - Code of conduct: code_of_conduct.md
  #     - Usage statistics: usage_statistics.md
  #     - FAQ: faq.md
  #     - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [agentic_security]


footer:
  links: []  # Removes the default footer credits

theme:
  name: material
  features:
    - navigation.expand
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: default
      primary: custom
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      primary: custom
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
  favicon: "https://res.cloudinary.com/dq0w2rtm9/image/upload/v1737555066/r17hrkre246doczwmvbv.png"

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/msoedov/agentic_security
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/agentic_security

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences