Skip to content
Obsidian Typings

AppVaultConfig

Properties

accentColor

accentColor: string

Appearance > Accent color

optional alwaysUpdateLinks: boolean

Files & Links > Automatically update internal links

attachmentFolderPath?

optional attachmentFolderPath: string

Files & Links > Attachment folder path

autoConvertHtml?

optional autoConvertHtml: boolean

Editor > Auto convert HTML

autoPairBrackets?

optional autoPairBrackets: boolean

Editor > Auto pair brackets

autoPairMarkdown?

optional autoPairMarkdown: boolean

Editor > Auto pair Markdown syntax

baseFontSize?

optional baseFontSize: number

Appearance > Font size

baseFontSizeAction?

optional baseFontSizeAction: boolean

Appearance > Quick font size adjustment

communityPluginSortOrder

communityPluginSortOrder: "download" | "update" | "release" | "alphabetical"

Community Plugins > Browse > Sort order

communityThemeSortOrder

communityThemeSortOrder: "download" | "update" | "release" | "alphabetical"

Themes > Browse > Sort order

cssTheme?

optional cssTheme: string

Appearance > Theme

defaultViewMode?

optional defaultViewMode: "source" | "preview"

Editor > Default view for new tabs

emacsyKeys?

optional emacsyKeys: boolean

enabledCssSnippets?

optional enabledCssSnippets: string[]

Appearance > CSS snippets

fileSortOrder?

optional fileSortOrder: "alphabetical"

focusNewTab?

optional focusNewTab: boolean

Editor > Always focus new tabs

foldHeading?

optional foldHeading: boolean

Editor > Fold heading

foldIndent?

optional foldIndent: boolean

Editor > Fold indent

hotkeys?

optional hotkeys: AppVaultConfigHotkeysRecord

Hotkeys

interfaceFontFamily?

optional interfaceFontFamily: string

Appearance > Interface font

legacyEditor?

optional legacyEditor: boolean

Editor > Use legacy editor

livePreview?

optional livePreview: boolean

mobilePullAction?

optional mobilePullAction: string

Mobile > Configure mobile Quick Action

mobileQuickRibbonItem?

optional mobileQuickRibbonItem: string

mobileToolbarCommands?

optional mobileToolbarCommands: string[]

Mobile > Manage toolbar options

monospaceFontFamily?

optional monospaceFontFamily: string

nativeMenus?

optional nativeMenus: null | boolean

Appearance > Native menus

newFileFolderPath?

optional newFileFolderPath: string

Files & Links > Default location for new notes | ‘folder’ > Folder to create new notes in

newFileLocation?

optional newFileLocation: "folder" | "root" | "current"

Files & Links > Default location for new notes

newLinkFormat?

optional newLinkFormat: "shortest" | "relative" | "absolute"

Files & Links > New link format

pdfExportSettings?

optional pdfExportSettings: object

Saved on executing ‘Export to PDF’ command

downscalePercent

downscalePercent: number

landscape

landscape: boolean

margin

margin: string

pageSize

pageSize: string

promptDelete?

optional promptDelete: boolean

Files & Links > Confirm line deletion

propertiesInDocument?

optional propertiesInDocument: "source" | "visible" | "hidden"

Editor > Properties in document

readableLineLength?

optional readableLineLength: boolean

Editor > Readable line length

rightToLeft?

optional rightToLeft: boolean

Editor > Right-to-left (RTL)

showFrontmatter?

optional showFrontmatter: boolean

showIndentGuide?

optional showIndentGuide: boolean

Editor > Show indentation guides

showInlineTitle?

optional showInlineTitle: boolean

Editor > Show inline title

showLineNumber?

optional showLineNumber: boolean

Editor > Show line numbers

showRibbon?

optional showRibbon: boolean

Appearance > Show ribbon

showUnsupportedFiles?

optional showUnsupportedFiles: boolean

Files & Links > Detect all file extensions

showViewHeader?

optional showViewHeader: boolean

Appearance > Show tab title bar

smartIndentList?

optional smartIndentList: boolean

Editor > Smart indent lists

spellcheck?

optional spellcheck: boolean

Editor > Spellcheck

spellcheckDictionary?

optional spellcheckDictionary: string[] | []

spellcheckLanguages?

optional spellcheckLanguages: null | string[]

Editor > Spellcheck languages

strictLineBreaks?

optional strictLineBreaks: boolean

Editor > Strict line breaks

tabSize?

optional tabSize: number

Editor > Tab indent size

textFontFamily?

optional textFontFamily: string

Appearance > Text font

theme?

optional theme: "moonstone" | "obsidian"

Appearance > Base color scheme

translucency?

optional translucency: boolean

Appearance > Translucent window

trashOption?

optional trashOption: "none" | "system" | "local"

Files & Links > Deleted files

types

types: object

optional useMarkdownLinks: boolean

Files & Links > Use [[Wikilinks]]

userIgnoreFilters?

optional userIgnoreFilters: null | string[]

Files & Links > Excluded files

useTab?

optional useTab: boolean

Editor > Indent using tabs

vimMode?

optional vimMode: boolean

Editor > Vim key bindings