Configuration
Every key in .deepdoc.yaml, with its default.
deepdoc init writes a complete .deepdoc.yaml. Every key is optional — an
empty value means "use the built-in default".
Two kinds of setting
Everything under site.* applies on the next deepdoc serve, free.
Everything else changes what gets documented and takes effect on your next
generate or update. See What it costs.
Project
Prop
Type
LLM
Prop
Type
Scope
Prop
Type
languages does not control which files are parsed. The supported set is
fixed; adding an entry here does not make DeepDoc understand a new language.
Generation
Prop
Type
Planner
Rarely worth changing.
Prop
Type
Scanning
Prop
Type
Site
Everything below applies on the next deepdoc serve with no regeneration.
Each has its own guide — colours,
logo and fonts, layout,
navigation.
Prop
Type
The remaining site.chrome switches — sidebar, sidebar_default_open_level,
sidebar_collapsible, toc, breadcrumb, page_footer, last_update,
theme_switch, search, generated_meta — are all booleans defaulting to
true, except edit_link. See Layout.
Chatbot
Off by default. See Chatbot.
Prop
Type
Reading and writing
deepdoc config show
deepdoc config set site.theme.preset oceanconfig set rejects keys that do not exist rather than silently writing a
setting that does nothing:
Error: Unknown config key: site.theme.presset
Did you mean:
site.theme.preset