Skip to content

AppVaultConfig

Unofficial

Vault-level configuration settings stored in the .obsidian config folder.

Import:

import type { AppVaultConfig } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface AppVaultConfig

Properties

Property Type Description
accentColor '' | string Appearance > Accent color.
alwaysUpdateLinks? boolean | false Files & Links > Automatically update internal links.
attachmentFolderPath? '/' | string Files & Links > Attachment folder path.
autoConvertHtml? boolean | true Editor > Auto convert HTML.
autoPairBrackets? boolean | true Editor > Auto pair brackets.
autoPairMarkdown? boolean | true Editor > Auto pair Markdown syntax.
baseFontSize? 16 | number Appearance > Font size.
baseFontSizeAction? boolean | true Appearance > Quick font size adjustment.
communityPluginSortOrder 'alphabetical' | 'download' | 'release' | 'update' Community Plugins > Browse > Sort order.
communityThemeSortOrder 'alphabetical' | 'download' | 'release' | 'update' Themes > Browse > Sort order.
cssTheme? '' | string Appearance > Theme.
defaultViewMode? 'preview' | 'source' Editor > Default view for new tabs.
emacsyKeys? boolean | true Whether Emacs-style keybindings are enabled.
enabledCssSnippets? string[] Appearance > CSS snippets.
fileSortOrder? 'alphabetical' Sort order for files in the file explorer.
focusNewTab? boolean | true Editor > Always focus new tabs.
foldHeading? boolean | true Editor > Fold heading.
foldIndent? boolean | true Editor > Fold indent.
hotkeys? AppVaultConfigHotkeysRecord Hotkeys.
interfaceFontFamily? '' | string Appearance > Interface font.
legacyEditor? boolean | false Editor > Use legacy editor.
livePreview? boolean | true Whether live preview mode is enabled in the editor.
mobilePullAction? 'command-palette:open' | string Mobile > Configure mobile Quick Action.
mobileQuickRibbonItem? '' | string Command ID for the mobile quick ribbon action item.
mobileToolbarCommands? string[] Mobile > Manage toolbar options.
monospaceFontFamily? '' | string Appearance > Monospace font.
nativeMenus? boolean | null Appearance > Native menus.
newFileFolderPath? '/' | string Files & Links > Default location for new notes | 'folder' > Folder to create new notes in.
newFileLocation? 'current' | 'folder' | 'root' Files & Links > Default location for new notes.
newLinkFormat? 'absolute' | 'relative' | 'shortest' Files & Links > New link format.
pdfExportSettings? PdfExportSettings Saved on executing 'Export to PDF' command.
promptDelete? boolean | true Files & Links > Confirm line deletion.
propertiesInDocument? 'hidden' | 'source' | 'visible' Editor > Properties in document.
readableLineLength? boolean | true Editor > Readable line length.
rightToLeft? boolean | false Editor > Right-to-left (RTL).
showIndentGuide? boolean | true Editor > Show indentation guides.
showInlineTitle? boolean | true Editor > Show inline title.
showLineNumber? boolean | false Editor > Show line numbers.
showRibbon? boolean | true Appearance > Show ribbon.
showUnsupportedFiles? boolean | false Files & Links > Detect all file extensions.
showViewHeader? boolean | false Appearance > Show tab title bar.
smartIndentList? boolean | true Editor > Smart indent lists.
spellcheck? boolean | false Editor > Spellcheck.
spellcheckLanguages? null | string[] Editor > Spellcheck languages.
strictLineBreaks? boolean | false Editor > Strict line breaks.
tabSize? 4 | number Editor > Tab indent size.
textFontFamily? '' | string Appearance > Text font.
theme? 'moonstone' | 'obsidian' Appearance > Base color scheme.
translucency? boolean | false Appearance > Translucent window.
trashOption? 'local' | 'none' | 'system' Files & Links > Deleted files.
types object Left-over storage for old properties types.
useMarkdownLinks? boolean | false Files & Links > Use [[Wikilinks]].
userIgnoreFilters? null | string[] Files & Links > Excluded files.
useTab? boolean | true Editor > Indent using tabs.
vimMode? boolean | false Editor > Vim key bindings.

Links to this page: