RAGuard/mkdocs.yml at main · Carlos-Projects/RAGuard · 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
site_name: RAGuard
site_description: Security scanner for Retrieval-Augmented Generation (RAG) systems
site_url: https://carlos-projects.github.io/RAGuard
repo_url: https://github.com/Carlos-Projects/RAGuard
edit_uri: edit/main/docs/

theme:
  name: material
  logo: logo.svg
  favicon: logo.svg
  palette:
    - scheme: slate
      primary: deep purple
      accent: teal
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - search.highlight

nav:
  - Home: index.md
  - Installation: installation.md
  - CLI Usage: usage.md
  - Python API: api/index.md
  - Architecture: architecture.md
  - Contributing: contributing.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Carlos-Projects/RAGuard