Configuration - components¶

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.

components¶

• admonitions.show · announcement_bar.show · code.show_copy_button · content.show · content.show_back_to_top · content.show_progress_bar · cookie_consent.show · feedback.show · footer.copyright_text · footer.show · footer.show_copyright · footer.show_meta · footer.show_prev_next · giscus.show · header.show · header.show_logo · header.show_page_title · header.show_palette_toggle · header.show_repo_link · header.show_search · header.show_site_name · highlighting.cdn_css_url · highlighting.cdn_url · highlighting.show · highlighting.theme_dark · highlighting.theme_light · keyboard_help.show · math.cdn_css_url · math.cdn_url · math.show · mermaid.cdn_url · mermaid.show · notes.show · prefetch.exclude · prefetch.external · prefetch.show · repo_popover.fields · repo_popover.show · search.placeholder · search.shortcut_key · search.show · sidebar.show · tags.show · toast.show · toc.show · toc.show_level_h2 · toc.show_level_h3 · toc.show_level_h4 · toc.title

theme.void.admonitions.show¶

Default	true

theme.void.announcement_bar.show¶

Default	true

theme.void.code.show_copy_button¶

Default	true

theme.void.content.show¶

Default	true

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.cookie_consent.show¶

Default	true

theme.void.feedback.show¶

Default	true

theme.void.footer.copyright_text¶

Default	""

theme.void.footer.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.footer.show_copyright¶

Default	true

theme.void.footer.show_meta¶

Default	true

theme.void.footer.show_prev_next¶

Default	true

theme.void.giscus.show¶

Default	true

theme.void.header.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.header.show_logo¶

Default	true

theme.void.header.show_page_title¶

Default	true

theme.void.header.show_palette_toggle¶

Default	true

theme.void.header.show_repo_link¶

Default	true

theme.void.header.show_search¶

Default	true

theme.void.header.show_site_name¶

Default	true

theme.void.highlighting.cdn_css_url¶

Default	""

theme.void.highlighting.cdn_url¶

Default	""

theme.void.highlighting.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.highlighting.theme_dark¶

Default	"github-dark"

theme.void.highlighting.theme_light¶

Default	"github"

theme.void.keyboard_help.show¶

Default	true

theme.void.math.cdn_css_url¶

Default	""

theme.void.math.cdn_url¶

Default	""

theme.void.math.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.mermaid.cdn_url¶

Default	""

theme.void.mermaid.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.notes.show¶

Default	true

theme.void.prefetch.exclude¶

Default	[]

theme.void.prefetch.external¶

Default	false

theme.void.prefetch.show¶

Default	true

theme.void.repo_popover.fields¶

Default	[description, owner_bio, author, followers, public_repos, location, stars, watchers, forks, open_issues, language, license, default_branch, commits, tags, latest_commit, commit_msg, created, updated, pushed]

theme.void.repo_popover.show¶

Default	true

theme.void.search.placeholder¶

Default	"Search..."

theme.void.search.shortcut_key¶

Default	"/"

theme.void.search.show¶

Default	true

theme.void.sidebar.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.tags.show¶

Default	true

theme.void.toast.show¶

Default	true

theme.void.toc.show¶

Default	true

State	Screenshot
On (default)
Off

theme.void.toc.show_level_h2¶

Default	true

theme.void.toc.show_level_h3¶

Default	true

theme.void.toc.show_level_h4¶

Default	true

theme.void.toc.title¶

Default	"On this page"