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

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

Links to this page: