book.toml

 1[book]
 2authors = ["The Zed Team"]
 3language = "en"
 4multilingual = false
 5src = "src"
 6title = "Zed"
 7site-url = "/docs/"
 8
 9[output.html]
10no-section-label = true
11preferred-dark-theme = "dark"
12additional-css = ["theme/page-toc.css", "theme/plugins.css", "theme/highlight.css"]
13additional-js  = ["theme/page-toc.js", "theme/plugins.js"]
14
15[output.html.print]
16enable = false
17
18# Redirects for `/docs` pages.
19#
20# All of the source URLs are interpreted relative to mdBook, so they must:
21# 1. Not start with `/docs`
22# 2. End in `.html`
23#
24# The destination URLs are interpreted relative to `https://zed.dev`.
25# - Redirects to other docs pages should end in `.html`
26# - You can link to pages on the Zed site by omitting the `/docs` in front of it.
27[output.html.redirect]
28# AI
29"/ai.html" = "/docs/ai/overview.html"
30"/assistant-panel.html" = "/docs/ai/agent-panel.html"
31"/assistant.html" = "/docs/assistant/assistant.html"
32"/assistant/assistant-panel.html" = "/docs/ai/agent-panel.html"
33"/assistant/assistant.html" = "/docs/ai/overview.html"
34"/assistant/commands.html" = "/docs/ai/text-threads.html"
35"/assistant/configuration.html" = "/docs/ai/configuration.html"
36"/assistant/context-servers.html" = "/docs/ai/mcp.html"
37"/assistant/contexts.html" = "/docs/ai/text-threads.html"
38"/assistant/inline-assistant.html" = "/docs/ai/inline-assistant.html"
39"/assistant/model-context-protocol.html" = "/docs/ai/mcp.html"
40"/assistant/prompting.html" = "/docs/ai/rules.html"
41"/language-model-integration.html" = "/docs/assistant/assistant.html"
42"/model-improvement.html" = "/docs/ai/ai-improvement.html"
43"/ai/temperature.html" = "/docs/ai/agent-settings.html#model-temperature"
44
45# Community
46"/community/feedback.html" = "/community-links"
47"/conversations.html" = "/community-links"
48
49# Debugger
50"/debuggers.html" = "/docs/debugger.html"
51
52# MCP
53"/assistant/model-context-protocolCitedby.html" = "/docs/ai/mcp.html"
54"/context-servers.html" = "/docs/ai/mcp.html"
55"/extensions/context-servers.html" = "/docs/extensions/mcp-extensions.html"
56
57# Languages
58"/adding-new-languages.html" = "/docs/extensions/languages.html"
59"/elixir.html" = "/docs/languages/elixir.html"
60"/javascript.html" = "/docs/languages/javascript.html"
61"/languages/languages/html.html" = "/docs/languages/html.html"
62"/languages/languages/javascript.html" = "/docs/languages/javascript.html"
63"/languages/languages/makefile.html" = "/docs/languages/makefile.html"
64"/languages/languages/nim.html" = "/docs/languages/nim.html"
65"/languages/languages/ruby.html" = "/docs/languages/ruby.html"
66"/languages/languages/scala.html" = "/docs/languages/scala.html"
67"/python.html" = "/docs/languages/python.html"
68"/ruby.html" = "/docs/languages/ruby.html"
69
70# Zed development
71"/contribute-to-zed.html" = "/docs/development.html#contributor-links"
72"/contributing.html" = "/docs/development.html#contributor-links"
73"/developing-zed.html" = "/docs/development.html"
74"/development/development/linux.html" = "/docs/development/linux.html"
75"/development/development/macos.html" = "/docs/development/macos.html"
76"/development/development/windows.html" = "/docs/development/windows.html"
77
78# Our custom preprocessor for expanding commands like `{#kb action::ActionName}`,
79# and other docs-related functions.
80#
81# Comment the below section out if you need to bypass the preprocessor for some reason.
82[preprocessor.zed_docs_preprocessor]
83command = "cargo run -p docs_preprocessor --"
84renderer = ["html"]