Configuration - shortcuts & interaction¶
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.
keyboard¶
- keyboard.custom · keyboard.enabled · keyboard.shortcuts.close.enabled · keyboard.shortcuts.close.key · keyboard.shortcuts.close.label · keyboard.shortcuts.help.enabled · keyboard.shortcuts.help.key · keyboard.shortcuts.help.label · keyboard.shortcuts.search.enabled · keyboard.shortcuts.search.key · keyboard.shortcuts.search.label · keyboard.shortcuts.search_down.enabled · keyboard.shortcuts.search_down.key · keyboard.shortcuts.search_down.label · keyboard.shortcuts.search_open.enabled · keyboard.shortcuts.search_open.key · keyboard.shortcuts.search_open.label · keyboard.shortcuts.search_up.enabled · keyboard.shortcuts.search_up.key · keyboard.shortcuts.search_up.label · keyboard.shortcuts.tab_left.enabled · keyboard.shortcuts.tab_left.key · keyboard.shortcuts.tab_left.label · keyboard.shortcuts.tab_right.enabled · keyboard.shortcuts.tab_right.key · keyboard.shortcuts.tab_right.label · keyboard.shortcuts.toggle_notes.enabled · keyboard.shortcuts.toggle_notes.key · keyboard.shortcuts.toggle_notes.label · keyboard.shortcuts.toggle_reading_mode.enabled · keyboard.shortcuts.toggle_reading_mode.key · keyboard.shortcuts.toggle_reading_mode.label · keyboard.shortcuts.toggle_reading_mode.persisted · keyboard.shortcuts.toggle_repo_popover.enabled · keyboard.shortcuts.toggle_repo_popover.key · keyboard.shortcuts.toggle_repo_popover.label · keyboard.shortcuts.toggle_scheme.enabled · keyboard.shortcuts.toggle_scheme.key · keyboard.shortcuts.toggle_scheme.label · keyboard.shortcuts.toggle_sidebar.enabled · keyboard.shortcuts.toggle_sidebar.key · keyboard.shortcuts.toggle_sidebar.label · keyboard.shortcuts.toggle_sidebar.persisted · keyboard.shortcuts.toggle_toc.enabled · keyboard.shortcuts.toggle_toc.key · keyboard.shortcuts.toggle_toc.label · keyboard.shortcuts.toggle_toc.persisted
theme.void.keyboard.custom¶
| Default | [] |
theme.void.keyboard.enabled¶
| Default | true |
| Purpose | Master switch for the keyboard shortcut system. |
| Example | keyboard: {enabled: true} |
theme.void.keyboard.shortcuts.close.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.close.key¶
| Default | "Escape" |
theme.void.keyboard.shortcuts.close.label¶
| Default | "Close active overlay" |
theme.void.keyboard.shortcuts.help.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.help.key¶
| Default | "?" |
theme.void.keyboard.shortcuts.help.label¶
| Default | "Show keyboard shortcuts" |
theme.void.keyboard.shortcuts.search.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.search.key¶
| Default | "/" |
| Purpose | Key that opens full-screen search. |
| Example | keyboard: {shortcuts: {search: {key: /}}} |
theme.void.keyboard.shortcuts.search.label¶
| Default | "Open search" |
theme.void.keyboard.shortcuts.search_down.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.search_down.key¶
| Default | "ArrowDown" |
theme.void.keyboard.shortcuts.search_down.label¶
| Default | "Navigate search results down" |
theme.void.keyboard.shortcuts.search_open.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.search_open.key¶
| Default | "Enter" |
theme.void.keyboard.shortcuts.search_open.label¶
| Default | "Open selected result" |
theme.void.keyboard.shortcuts.search_up.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.search_up.key¶
| Default | "ArrowUp" |
theme.void.keyboard.shortcuts.search_up.label¶
| Default | "Navigate search results up" |
theme.void.keyboard.shortcuts.tab_left.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.tab_left.key¶
| Default | "ArrowLeft" |
theme.void.keyboard.shortcuts.tab_left.label¶
| Default | "Switch to previous tab" |
theme.void.keyboard.shortcuts.tab_right.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.tab_right.key¶
| Default | "ArrowRight" |
theme.void.keyboard.shortcuts.tab_right.label¶
| Default | "Switch to next tab" |
theme.void.keyboard.shortcuts.toggle_notes.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_notes.key¶
| Default | "Ctrl+Shift+N" |
theme.void.keyboard.shortcuts.toggle_notes.label¶
| Default | "Toggle notes panel" |
theme.void.keyboard.shortcuts.toggle_reading_mode.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_reading_mode.key¶
| Default | "Alt+Shift+R" |
theme.void.keyboard.shortcuts.toggle_reading_mode.label¶
| Default | "Toggle reading mode" |
theme.void.keyboard.shortcuts.toggle_reading_mode.persisted¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_repo_popover.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_repo_popover.key¶
| Default | "Ctrl+Shift+G" |
theme.void.keyboard.shortcuts.toggle_repo_popover.label¶
| Default | "Toggle repo popover" |
theme.void.keyboard.shortcuts.toggle_scheme.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_scheme.key¶
| Default | "Ctrl+Shift+L" |
theme.void.keyboard.shortcuts.toggle_scheme.label¶
| Default | "Toggle color scheme" |
theme.void.keyboard.shortcuts.toggle_sidebar.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_sidebar.key¶
| Default | "Ctrl+Shift+B" |
| Purpose | Key that folds/expands the sidebar. |
| Example | keyboard: {shortcuts: {toggle_sidebar: {key: Ctrl+Shift+B}}} |
theme.void.keyboard.shortcuts.toggle_sidebar.label¶
| Default | "Toggle sidebar" |
theme.void.keyboard.shortcuts.toggle_sidebar.persisted¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_toc.enabled¶
| Default | true |
theme.void.keyboard.shortcuts.toggle_toc.key¶
| Default | "Ctrl+Shift+T" |
theme.void.keyboard.shortcuts.toggle_toc.label¶
| Default | "Toggle table of contents" |
theme.void.keyboard.shortcuts.toggle_toc.persisted¶
| Default | true |
reading_mode¶
- reading_mode.enabled · reading_mode.notes.open_on_enter · reading_mode.notes.show · reading_mode.persisted · reading_mode.sections.footer · reading_mode.sections.header · reading_mode.sections.progress · reading_mode.sections.sidebar · reading_mode.sections.toc · reading_mode.shortcut_key · reading_mode.typography.font_size · reading_mode.typography.line_height · reading_mode.typography.measure
theme.void.reading_mode.enabled¶
| Default | true |
| Purpose | Master switch for distraction-free reading mode. |
| Example | reading_mode: {enabled: true} |
theme.void.reading_mode.notes.open_on_enter¶
| Default | false |
theme.void.reading_mode.notes.show¶
| Default | true |
theme.void.reading_mode.persisted¶
| Default | true |
theme.void.reading_mode.sections.footer¶
| Default | true |
theme.void.reading_mode.sections.header¶
| Default | true |
theme.void.reading_mode.sections.progress¶
| Default | true |
theme.void.reading_mode.sections.sidebar¶
| Default | true |
theme.void.reading_mode.sections.toc¶
| Default | true |
theme.void.reading_mode.shortcut_key¶
| Default | "Alt+Shift+R" |
| Purpose | Key that enters/leaves reading mode. |
| Example | reading_mode: {shortcut_key: Alt+Shift+R} |
theme.void.reading_mode.typography.font_size¶
| Default | "1.125rem" |
theme.void.reading_mode.typography.line_height¶
| Default | "1.75" |
theme.void.reading_mode.typography.measure¶
| Default | "100%" |
action_cluster¶
- action_cluster.actions · action_cluster.behavior.animation · action_cluster.behavior.close_on_escape · action_cluster.behavior.close_on_outside · action_cluster.behavior.close_on_select · action_cluster.behavior.focus_trap · action_cluster.behavior.min_actions · action_cluster.behavior.tooltips · action_cluster.enabled · action_cluster.main.glass · action_cluster.main.icon · action_cluster.main.icon_transform · action_cluster.main.size · action_cluster.offset.bottom · action_cluster.offset.left · action_cluster.position · action_cluster.replaces_notes_button
theme.void.action_cluster.actions¶
| Default | [{badge: none, enabled: true, icon: help, id: keyboard_help, label: Keyboard shortcuts, shortcut: '?'}, {badge: none, enabled: true, icon: notes, id: notes, label: Open notes panel, shortcut: Ctrl+Shift+N}, {badge: time, enabled: true, icon: timer, id: timer, label: Focus timer, shortcut: Alt+Shift+T}, {badge: none, enabled: true, icon: reading, id: reading_mode, label: Reading mode, shortcut: Alt+Shift+R}] |
theme.void.action_cluster.behavior.animation¶
| Default | "normal" |
theme.void.action_cluster.behavior.close_on_escape¶
| Default | true |
theme.void.action_cluster.behavior.close_on_outside¶
| Default | true |
theme.void.action_cluster.behavior.close_on_select¶
| Default | true |
theme.void.action_cluster.behavior.focus_trap¶
| Default | true |
theme.void.action_cluster.behavior.min_actions¶
| Default | 2 |
theme.void.action_cluster.behavior.tooltips¶
| Default | true |
theme.void.action_cluster.enabled¶
| Default | true |
| Purpose | Master switch for the floating plus action cluster. |
| Example | action_cluster: {enabled: true} |
theme.void.action_cluster.main.glass¶
| Default | true |
theme.void.action_cluster.main.icon¶
| Default | "plus" |
theme.void.action_cluster.main.icon_transform¶
| Default | true |
theme.void.action_cluster.main.size¶
| Default | "44px" |
theme.void.action_cluster.offset.bottom¶
| Default | "16px" |
theme.void.action_cluster.offset.left¶
| Default | "16px" |
theme.void.action_cluster.position¶
| Default | "bottom-left" |
| Purpose | Which corner the floating cluster pins to. |
| Example | action_cluster: {position: "bottom-left"} |
theme.void.action_cluster.replaces_notes_button¶
| Default | true |
timer¶
- timer.badge_in_cluster · timer.colors.progress · timer.default_minutes · timer.display_format · timer.document_title · timer.enabled · timer.notifications.enabled · timer.notifications.sound · timer.notifications.toast · timer.persist · timer.reading.show · timer.settings_popup · timer.start_with_reading · timer.toc.position · timer.toc.show · timer.toc.style
theme.void.timer.badge_in_cluster¶
| Default | true |
theme.void.timer.colors.progress¶
| Default | "#8a5a33" |
theme.void.timer.default_minutes¶
| Default | 25 |
| Purpose | Default focus session length in minutes. |
| Example | timer: {default_minutes: 25} |
theme.void.timer.display_format¶
| Default | "mm:ss" |
theme.void.timer.document_title¶
| Default | false |
theme.void.timer.enabled¶
| Default | true |
| Purpose | Master switch for the built-in focus timer. |
| Example | timer: {enabled: true} |
theme.void.timer.notifications.enabled¶
| Default | true |
theme.void.timer.notifications.sound¶
| Default | true |
theme.void.timer.notifications.toast¶
| Default | true |
theme.void.timer.persist¶
| Default | true |
theme.void.timer.reading.show¶
| Default | true |
theme.void.timer.settings_popup¶
| Default | true |
theme.void.timer.start_with_reading¶
| Default | false |
theme.void.timer.toc.position¶
| Default | "bottom" |
theme.void.timer.toc.show¶
| Default | true |
theme.void.timer.toc.style¶
| Default | "ring" |