Inkiva logoInkivaDocs
User documentation

Preferences#

Preferences can be changed in the settings window or in preferences.json in the application data directory. The tables below describe the packaged defaults for a new profile. Existing profiles keep their own values, and values accepted by the application are defined in packages/desktop/src/main/preferences/schema.json.

The shipped default file is packages/desktop/static/preference.json. If a setting appears different after an upgrade, check the value in your own preferences.json first.

General#

KeyTypeDefaultDescription
autoSaveBooleantrueAutomatically save the document after a change.
autoSaveDelayNumber5000Delay in milliseconds before an automatic save. Minimum 1000.
titleBarStyleStringcustomWindows titlebar style: custom or native.
openFilesInNewWindowBooleanfalseOpen a file in a new window instead of the current window.
openFolderInNewWindowBooleanfalseOpen a folder in a new window instead of the current window.
zoomNumber1.0Application zoom level, from 0.5 to 2.0.
hideScrollbarBooleanfalseHide editor scrollbars.
wordWrapInTocBooleanfalseWrap long heading labels in the Outline panel.
fileSortByStringcreatedSort files in an opened folder by created, modified, or title.
fileSortOrderStringascSort files in ascending (asc) or descending (desc) order.
startUpActionStringrestoreAllStartup behavior: folder, openLastFolder, blank, or restoreAll.
defaultDirectoryToOpenString""Folder to open when startUpAction is folder.
languageStringzh-CNDisplay language.
restoreLayoutStateBooleantrueRestore open tabs and layout on startup.
openedFilesInSidebarBooleantrueShow the Opened Files subsection in the Files panel.
shortcutStyleStringtyporaShortcut preset: typora or marktext. See Key bindings.
treePathExcludePatternsArray of Strings[]Glob patterns excluded from the Files tree.

Editor#

KeyTypeDefaultDescription
editorFontFamilyStringGeorgiaWriting-surface font family.
fontSizeNumber18Editor font size in pixels, from 12 to 32.
lineHeightNumber1.7Editor line height, from 1.2 to 2.0.
paragraphSpacingNumber0.75Spacing between paragraphs.
wrapCodeBlocksBooleanfalseWrap long lines inside code blocks.
editorLineWidthString780pxMaximum writing-surface width. Accepts an empty value or a ch, px, or % value.
codeFontSizeNumber14Font size inside code blocks, from 12 to 28.
codeFontFamilyStringDejaVu Sans MonoCode-block font family.
codeBlockLineNumbersBooleanfalseShow line numbers inside code blocks.
trimUnnecessaryCodeBlockEmptyLinesBooleantrueTrim empty lines at the beginning and end of code blocks.
autoPairBracketBooleantrueAuto-close brackets while editing.
autoPairMarkdownSyntaxBooleantrueAuto-close Markdown delimiters while editing.
autoPairQuoteBooleantrueAuto-close quotation marks while editing.
endOfLineStringdefaultNewline style: default, lf, or crlf.
defaultEncodingStringutf8Default file encoding.
autoGuessEncodingBooleantrueGuess a file's encoding when opening it.
autoNormalizeLineEndingsBooleanfalseNormalize line endings when opening a file.
trimTrailingNewlineNumber2Trailing-newline behavior: 0 trim all, 1 ensure one, 2 auto-detect, 3 disabled.
textDirectionStringltrWriting direction: ltr or rtl.
hideQuickInsertHintBooleanfalseHide the empty-paragraph hint for the / quick-insert menu.
hideLinkPopupBooleanfalseHide the link popup shown when hovering over a link.
autoCheckBooleanfalseAutomatically check related task items when one is toggled.

The Editor page exposes the writing-surface controls described above:

Inkiva Preferences window on the Editor page

Markdown#

KeyTypeDefaultDescription
preferLooseListItemBooleantruePrefer loose list items when serializing lists.
bulletListMarkerString-Bullet marker: -, *, or +.
orderListDelimiterString.Ordered-list delimiter: . or ).
preferHeadingStyleStringatxHeading style: atx or setext.
tabSizeNumber4Number of spaces represented by a tab.
listIndentationMixed1List indentation: dfm, tab, or a number from 1 to 4.
frontmatterTypeString-Front matter delimiter: - (YAML), + (TOML), ; (JSON), or { (JSON).
superSubScriptBooleanfalseEnable pandoc-style superscript and subscript syntax.
footnoteBooleanfalseEnable footnote syntax.
isHtmlEnabledBooleantrueRender inline HTML.
isGitlabCompatibilityEnabledBooleanfalseEnable GitLab compatibility mode.
sequenceThemeStringhandSequence-diagram style: hand or simple.
plantumlServerStringhttps://www.plantuml.com/plantumlPlantUML server used to render PlantUML diagrams.

Appearance#

KeyTypeDefaultDescription
themeStringlightCurrent appearance: light, dark, or paper. See Appearances.
followSystemThemeBooleanfalseSwitch between the configured light and dark appearances with the operating system.
lightModeThemeStringlightAppearance used for system light mode when followSystemTheme is enabled.
darkModeThemeStringdarkAppearance used for system dark mode when followSystemTheme is enabled.

Spelling#

KeyTypeDefaultDescription
spellcheckerEnabledBooleanfalseEnable spell checking.
spellcheckerNoUnderlineBooleanfalseKeep spell checking enabled without underlining misspelled words.
spellcheckerLanguageStringen-USDefault spell-checking language, using a BCP-47 language tag.

Image#

KeyTypeDefaultDescription
imageInsertActionStringpathDefault local-image action: upload, folder, or path.
imagePreferRelativeDirectoryBooleanfalsePrefer copying images into a relative directory.
imageRelativeDirectoryBaseStringfileAnchor relative images to the document (file) or project root (folder).
imageRelativeDirectoryNameStringassetsFolder name or path for copied images. Supports the ${filename} variable.

Editable via file#

The following entries are marked --internal in the schema. They have no settings-window control and must be edited directly in preferences.json.

View#

KeyTypeDefaultDescription
sideBarVisibilityBooleantrueInitial sidebar visibility.
tabBarVisibilityBooleantrueInitial tab-bar visibility.
sourceCodeModeEnabledBooleanfalseInitial source-code mode.

General (internal)#

KeyTypeDefaultDescription
lastOpenedFolderString""Last folder opened, used when restoring the previous session.

Custom CSS#

KeyTypeDefaultDescription
customCssString""CSS appended after the active application appearance stylesheet.

File system / Searcher#

KeyTypeDefaultDescription
searchExclusionsArray of Strings[]Filename glob patterns excluded from in-folder search.
searchMaxFileSizeString""Maximum search size, such as 50K, 10M, or 2G; empty means unlimited.
searchIncludeHiddenBooleanfalseInclude hidden files and directories.
searchNoIgnoreBooleanfalseIgnore ignore-files such as .gitignore.
searchFollowSymlinksBooleantrueFollow symbolic links while searching.

Watcher#

KeyTypeDefaultDescription
watcherUsePollingBooleanfalseUse polling for file changes; useful for network shares but more CPU-intensive.