LettuceDetect/mkdocs.yml at main · KRLabsOrg/LettuceDetect · 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
site_name: LettuceDetect
site_description: A lightweight hallucination detection framework for RAG applications
site_url: https://krlabsorg.github.io/LettuceDetect
repo_url: https://github.com/KRLabsOrg/LettuceDetect
repo_name: KRLabsOrg/LettuceDetect

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.code.annotate
    - toc.follow
  icon:
    repo: fontawesome/brands/github

extra_css:
  - assets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: sphinx
            merge_init_into_class: true
            show_if_no_docstring: false

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Models: getting-started/models.md
  - Guide:
    - Detection Methods: guide/detection-methods.md
    - Evaluation: guide/evaluation.md
    - Training: guide/training.md
    - Multilingual: guide/multilingual.md
    - Web API: guide/api.md
    - Integrations: guide/integrations.md
  - Code Hallucination Dataset:
    - Overview: code-hallucination/index.md
    - Pipeline Phases: code-hallucination/phases.md
    - Configuration: code-hallucination/configuration.md
    - Architecture Research: code-hallucination/architecture-research.md
  - Research:
    - TinyLettuce: TINYLETTUCE.md
    - Multilingual (EuroBERT): EUROBERT.md
  - API Reference:
    - Inference: api/inference.md
    - Detectors: api/detectors.md
    - Datasets: api/datasets.md
    - Training: api/training.md
  - Benchmarks: benchmarks.md