Unplug/mkdocs.yml at dev · UnplugAI/Unplug · 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
site_name: Unplug
site_description: Agent runtime security for LLM applications.
site_url: https://unplugai.github.io/Unplug/
repo_url: https://github.com/UnplugAI/Unplug
repo_name: UnplugAI/Unplug
edit_uri: edit/dev/docs/
copyright: Apache 2.0

docs_dir: docs

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - navigation.instant
    - content.code.copy
    - content.action.edit
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: green
      toggle:
        icon: material/weather-night
        name: Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: green
      toggle:
        icon: material/weather-sunny
        name: Light mode

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  # custom_fences turns ```mermaid blocks into rendered diagrams. Material's
  # bundle pulls mermaid@11 from unpkg at runtime, so diagrams need the network.
  # Vendoring it is tracked separately.
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite

nav:
  - Home: index.md
  - Start here:
      - Getting started: GETTING_STARTED.md
      - Architecture: ARCHITECTURE.md
      - Public API: PUBLIC_API.md
  - Protecting an agent:
      - Agent actions: AGENT_ACTIONS.md
      - Agent flow security: AGENT_FLOW_SECURITY.md
      - RAG defense: RAG_DEFENSE.md
      - Hermes agent security: HERMES_AGENT_SECURITY.md
  - Detection:
      - Benchmarks: BENCHMARKS.md
      - Limits and the LLM judge: LIMITS_AND_JUDGE.md
      - ML integration: ML_INTEGRATION.md
      - Phase C evaluation: EVAL_PHASE_C.md
  - Running it:
      - Deployment: DEPLOYMENT.md
      - Integrations: INTEGRATIONS.md
      - Testing harness: TESTING_HARNESS.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/UnplugAI/Unplug
    - icon: fontawesome/solid/robot
      link: https://huggingface.co/Unplug-AI/unplug-tiny-v1
      name: unplug-tiny-v1 on Hugging Face