Configuration - content & AI¶

Generated from the live plugin tables (_VOID_TOKEN_MAP, _void_defaults, the _VOID_DEFAULT_* dicts and the compiled token defaults in void.scss) by tools/emit_config_reference.py. The page is regenerated in CI and can never drift from the shipped code.

content¶

• content.admonitions.enabled · content.admonitions.types.danger.color · content.admonitions.types.danger.icon · content.admonitions.types.info.color · content.admonitions.types.info.icon · content.admonitions.types.note.color · content.admonitions.types.note.icon · content.admonitions.types.success.color · content.admonitions.types.success.icon · content.admonitions.types.tip.color · content.admonitions.types.tip.icon · content.admonitions.types.warning.color · content.admonitions.types.warning.icon · content.back_to_top_label · content.back_to_top_threshold · content.code.annotate · content.code.copied_label · content.code.copy_label · content.code.highlight_lines · content.code.line_number_color · content.code.line_number_start · content.code.show_copy_button · content.code.show_line_numbers · content.glass · content.max_width · content.padding · content.progress_bar_color · content.show_back_to_top · content.show_progress_bar · content.tables.bordered · content.tables.responsive · content.tables.striped · content.task_lists.custom_checkbox · content.task_lists.enabled · content.task_lists.persist_state · content.typography.anchor_symbol · content.typography.heading_anchor · content.typography.image_behavior · content.typography.image_lightbox · content.typography.link_behavior · content.typography.video_behavior

theme.void.content.admonitions.enabled¶

Default	true

theme.void.content.admonitions.types.danger.color¶

Default	""

theme.void.content.admonitions.types.danger.icon¶

Default	""

theme.void.content.admonitions.types.info.color¶

Default	""

theme.void.content.admonitions.types.info.icon¶

Default	""

theme.void.content.admonitions.types.note.color¶

Default	""

theme.void.content.admonitions.types.note.icon¶

Default	""

theme.void.content.admonitions.types.success.color¶

Default	""

theme.void.content.admonitions.types.success.icon¶

Default	""

theme.void.content.admonitions.types.tip.color¶

Default	""

theme.void.content.admonitions.types.tip.icon¶

Default	""

theme.void.content.admonitions.types.warning.color¶

Default	""

theme.void.content.admonitions.types.warning.icon¶

Default	""

theme.void.content.back_to_top_label¶

Default	"Back to top"

theme.void.content.back_to_top_threshold¶

Default	500

theme.void.content.code.annotate¶

Default	true

theme.void.content.code.copied_label¶

Default	""

theme.void.content.code.copy_label¶

Default	""

theme.void.content.code.highlight_lines¶

Default	true

theme.void.content.code.line_number_color¶

Default	""

theme.void.content.code.line_number_start¶

Default	1

theme.void.content.code.show_copy_button¶

Default	true

theme.void.content.code.show_line_numbers¶

Default	false

theme.void.content.glass¶

Default	false

theme.void.content.max_width¶

Default	""

theme.void.content.padding¶

Default	""

theme.void.content.progress_bar_color¶

Default	""

theme.void.content.show_back_to_top¶

Default	true

theme.void.content.show_progress_bar¶

Default	true
Purpose	Toggles the top-edge reading progress bar.
Example	content: {show_progress_bar: true}

theme.void.content.tables.bordered¶

Default	false

theme.void.content.tables.responsive¶

Default	true

theme.void.content.tables.striped¶

Default	false

theme.void.content.task_lists.custom_checkbox¶

Default	true

theme.void.content.task_lists.enabled¶

Default	true

theme.void.content.task_lists.persist_state¶

Default	true

theme.void.content.typography.anchor_symbol¶

Default	""

theme.void.content.typography.heading_anchor¶

Default	true

theme.void.content.typography.image_behavior¶

Default	"normal"

theme.void.content.typography.image_lightbox¶

Default	true
Purpose	Toggles click-to-zoom image preview in the article.
Example	content: {typography: {image_lightbox: true}}

theme.void.content.typography.link_behavior¶

Default	"smooth"

theme.void.content.typography.video_behavior¶

Default	"responsive"

config_builder¶

• config_builder.cluster_action · config_builder.enabled · config_builder.open_target · config_builder.toc_footer · config_builder.url

theme.void.config_builder.cluster_action¶

Default	true

theme.void.config_builder.enabled¶

Default	false
Purpose	Dev tool that generates mkdocs.yml from a guided form. Ships OFF on purpose.
Example	config_builder: {enabled: false, url: assets/config-builder.html}

theme.void.config_builder.open_target¶

Default	"_blank"

theme.void.config_builder.toc_footer¶

Default	true

theme.void.config_builder.url¶

Default	"assets/config-builder.html"

ai_reader¶

• ai_reader.auto_title · ai_reader.description · ai_reader.enabled · ai_reader.exclude · ai_reader.llms · ai_reader.llms_full · ai_reader.markup · ai_reader.overwrite · ai_reader.sitemap · ai_reader.url_style · ai_reader.watermark.enabled · ai_reader.watermark.footer · ai_reader.watermark.header · ai_reader.watermark.include_generated · ai_reader.watermark.include_site · ai_reader.watermark.include_url · ai_reader.watermark.include_version · ai_reader.watermark.text

theme.void.ai_reader.auto_title¶

Default	true

theme.void.ai_reader.description¶

Default	""

theme.void.ai_reader.enabled¶

Default	true
Purpose	Master switch for the watermarked markdown mirrors AI agents can fetch.
Example	ai_reader: {enabled: true}

theme.void.ai_reader.exclude¶

Default	[]

theme.void.ai_reader.llms¶

Default	true

theme.void.ai_reader.llms_full¶

Default	true

theme.void.ai_reader.markup¶

Default	true

theme.void.ai_reader.overwrite¶

Default	false

theme.void.ai_reader.sitemap¶

Default	true

theme.void.ai_reader.url_style¶

Default	"sidecar"

theme.void.ai_reader.watermark.enabled¶

Default	true

theme.void.ai_reader.watermark.footer¶

Default	true

theme.void.ai_reader.watermark.header¶

Default	true

theme.void.ai_reader.watermark.include_generated¶

Default	true

theme.void.ai_reader.watermark.include_site¶

Default	true

theme.void.ai_reader.watermark.include_url¶

Default	true

theme.void.ai_reader.watermark.include_version¶

Default	true

theme.void.ai_reader.watermark.text¶

Default	"Generated by Void for AI agents."