-
Notifications
You must be signed in to change notification settings - Fork 469
Expand file tree
/
Copy pathmkdocs.yml
More file actions
149 lines (138 loc) · 5.15 KB
/
Copy pathmkdocs.yml
File metadata and controls
149 lines (138 loc) · 5.15 KB
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# Configuration for the Lemonade Server documentation site.
#
# The site is built with Zensical (the successor to MkDocs Material). Zensical
# reads mkdocs.yml natively, so the filename and most of the Material schema
# carry over from the previous MkDocs Material setup. See zensical.org for
# documentation and upgrades.
#
# To install dependencies:
# pip install -r docs/assets/docs_requirements.txt
#
# To build (and stage to docs/docs/, the lemonade-server.ai layout):
# python docs/publish_website_docs.py
#
# To serve locally during authoring:
# zensical serve
site_name: Lemonade Server Documentation
site_url: https://lemonade-server.ai/
site_description: Lemonade Server is a lightweight, open-source local LLM server that allows you to run and manage multiple AI applications on your local machine. It provides a simple CLI for managing applications and supports various LLMs, making it easy to deploy and use AI models locally.
edit_uri: README.md
repo_name: lemonade-sdk/lemonade
repo_url: https://github.com/lemonade-sdk/lemonade
plugins:
- search
theme:
name: material
custom_dir: docs/overrides
# Match the homepage's brand mark: small favicon glyph + "Lemonade" wordmark
# (the wordmark is injected via .md-logo::after in zest-theme.css).
logo: assets/favicon.ico
favicon: assets/favicon.ico
features:
- navigation.footer
- navigation.tracking
- navigation.top
- content.code.annotate
- content.code.copy
# Fonts are loaded by docs/overrides/main.html's `fonts` block (Plus Jakarta
# Sans + Manrope + Material Symbols), not via theme.font, to avoid double
# @import requests and keep parity with the homepage's font setup.
palette:
- scheme: zest-light
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: zest-dark
toggle:
icon: material/weather-sunny
name: Switch to light mode
# Sidebar / nav structure
nav:
- Welcome: index.md
- User Guide:
- Getting Started: guide/README.md
- Install:
- Supported Platforms: guide/install/README.md
- Ubuntu: guide/install/ubuntu.md
- Arch: guide/install/arch.md
- Fedora: guide/install/fedora.md
- Debian: guide/install/debian.md
- Docker: guide/install/docker.md
- Local Server Concepts: guide/concepts.md
- CLI: guide/cli.md
- Chat in your terminal: guide/cli-chat.md
- Configuration:
- Service: guide/configuration/README.md
- Custom Models: guide/configuration/custom-models.md
- Running Many Models: guide/configuration/multi-model.md
- llama.cpp: guide/configuration/llamacpp.md
- vLLM: guide/configuration/vllm.md
- Moonshine: guide/configuration/moonshine.md
- Cloud Offload: guide/configuration/cloud.md
- Telemetry: guide/telemetry.md
- FAQ: guide/faq.md
- Development:
- Overview: dev/README.md
- Philosophy: dev/philosophy.md
- Working Groups: dev/working-groups/README.md
- Contribute: dev/contribute.md
- Documentation Guide: dev/documentation.md
- Testing: dev/testing.md
- C++: dev/getting-started.md
- Adding a Backend: dev/adding-a-backend.md
- Backends Reference: dev/backends-reference.md
- Desktop App: dev/app.md
- Web UI: dev/web-ui.md
- Lemonade Omni Models: dev/lemonade-omni.md
- Router Policies: dev/router-policy.md
- Infrastructure: dev/self-hosted-runners.md
- Release Process: dev/release.md
- App Integrations:
- Overview: integrations/README.md
- AI Toolkit: integrations/ai-toolkit.md
- AnythingLLM: integrations/anythingLLM.md
- Claude Code: integrations/claude-code.md
- CodeGPT: integrations/codeGPT.md
- Continue: integrations/continue.md
- LangChain: integrations/langchain.md
- Lemon Zest: integrations/lemon-zest.md
- Mindcraft: integrations/mindcraft.md
- Open Hands: integrations/open-hands.md
- Open WebUI: integrations/open-webui.md
- Wut: integrations/wut.md
- API Spec:
- Overview: api/README.md
- OpenAI Compatible: api/openai.md
- Ollama Compatible: api/ollama.md
- Anthropic Compatible: api/anthropic.md
- llama.cpp Specific: api/llamacpp.md
- Lemonade Specific: api/lemonade.md
- Embeddable Lemonade:
- Overview: embeddable/README.md
- Runtime: embeddable/runtime.md
- Backends: embeddable/backends.md
- Models: embeddable/models.md
- Building from Source: embeddable/building.md
# Footer social links
extra:
homepage: https://lemonade-server.ai
social:
- icon: simple/youtube
link: https://www.youtube.com/@AMDDevCentral
- icon: simple/github
link: https://github.com/lemonade-sdk/lemonade
- icon: simple/discord
link: https://discord.gg/5xXzkMu8Zk
copyright: "© 2026 AMD. Licensed under Apache 2.0."
# website-styles.css owns design tokens; zest-theme.css maps them to Zensical.
extra_css:
- assets/website-styles.css
- assets/zest-theme.css
# carousel.js handles YouTube embeds inside docs pages.
extra_javascript:
- assets/carousel.js
markdown_extensions:
- admonition
- pymdownx.superfences # Better code blocks
- pymdownx.tabbed: # Tabbed code blocks
alternate_style: true