headroom/mkdocs.yml at main · chopratejas/headroom · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
site_name: Headroom
site_description: "The Context Optimization Layer for LLM Applications — compress everything your AI agent reads."
site_url: https://chopratejas.github.io/headroom
repo_url: https://github.com/chopratejas/headroom
repo_name: chopratejas/headroom
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
    - header.autohide
  icon:
    repo: fontawesome/brands/github
    logo: material/layers-outline

plugins:
  - search

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: quickstart.md
    - Installation: getting-started.md
    - Docker-Native Install: docker-install.md
    - Persistent Installs: persistent-installs.md
    - Configuration: configuration.md
  - User Guide:
    - Proxy Server: proxy.md
    - Compression Pipeline: compression.md
    - CCR (Lossless Retrieval): ccr.md
    - Image Compression: image-compression.md
    - Memory System: memory.md
    - Shared Context: shared-context.md
    - Failure Learning: learn.md
  - Integrations:
    - Overview: integration-guide.md
    - LangChain: langchain.md
    - Agno: agno.md
    - Strands: strands.md
    - MCP Tools: mcp.md
  - How It Works:
    - Architecture: ARCHITECTURE.md
    - Transforms Pipeline: transforms.md
    - Text Compression: text-compression.md
    - LLMLingua: llmlingua.md
  - Benchmarks:
    - Accuracy: benchmarks.md
    - Latency: LATENCY_BENCHMARKS.md
    - Limitations: LIMITATIONS.md
  - Reference:
    - CLI: cli.md
    - API: api.md
    - SDK: sdk.md
    - Metrics & Observability: metrics.md
    - Error Codes: errors.md
    - Troubleshooting: troubleshooting.md
  - Deployment:
    - macOS LaunchAgent: macos-deployment.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/chopratejas/headroom
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/headroom-ai/
    - icon: fontawesome/brands/discord
      link: https://discord.gg/yRmaUNpsPJ
  generator: false