Back to Marktext

PREFERENCES

docs/PREFERENCES.md

0.17.112.8 KB
Original Source

MarkText Preferences

Preferences can be controlled and modified in the settings window or via the preferences.json file in the application data directory.

General

KeyTypeDefault ValueDescription
autoSaveBooleanfalseAutomatically save the content being edited. option value: true, false
autoSaveDelayNumber5000The delay in milliseconds after a changed file is saved automatically? 1000 ~10000
titleBarStyleStringcustomThe title bar style on Linux and Window: custom or native
openFilesInNewWindowBooleanfalsetrue, false
openFolderInNewWindowBooleanfalsetrue, false
zoomNumber1.0The zoom level. Between 0.5 and 2.0 inclusive.
hideScrollbarBooleanfalseWhether to hide scrollbars. Optional value: true, false
wordWrapInTocBooleanfalseWhether to enable word wrap in TOC. Optional value: true, false
fileSortByStringcreatedSort files in opened folder by created time, modified time and title.
startUpActionStringlastStateThe action after MarkText startup, open the last edited content, open the specified folder or blank page, optional value: lastState, folder, blank
defaultDirectoryToOpenString""The path that should be opened if startUpAction=folder.
languageStringenThe language MarkText use.

Editor

KeyTypeDefautDescription
fontSizeNumber16Font size in pixels. 12 ~ 32
editorFontFamilyStringOpen SansFont Family
lineHeightNumber1.6Line Height
autoPairBracketBooleantrueAutomatically brackets when editing
autoPairMarkdownSyntaxBooleantrueAutocomplete markdown syntax
autoPairQuoteBooleantrueAutomatic completion of quotes
endOfLineStringdefaultThe newline character used at the end of each line. The default value is default, which selects your operating system's default newline character. lf crlf default
textDirectionStringltrThe writing text direction, optional value: ltr or rtl
codeFontSizeNumber14Font size on code block, the range is 12 ~ 28
codeFontFamilyStringDejaVu Sans MonoCode font family
trimUnnecessaryCodeBlockEmptyLinesBooleantrueWhether to trim the beginning and end empty line in Code block
hideQuickInsertHintBooleanfalseHide hint for quickly creating paragraphs
imageDropActionStringfolderThe default behavior after paste or drag the image to MarkText, upload it to the image cloud (if configured), move to the specified folder, insert the path
defaultEncodingStringutf8The default file encoding
autoGuessEncodingBooleantrueTry to automatically guess the file encoding when opening files
trimTrailingNewlineEnum2Ensure a single trailing newline or whether trailing newlines should be removed: 0: trim all trailing newlines, 1: ensure single newline, 2: auto detect, 3: disabled.
hideLinkPopupBooleanfalseIt will not show the link popup when hover over the link if set hideLinkPopup to true
autoCheckBooleanfalseWhether to automatically check related task. Optional value: true, false

Markdown

KeyTypeDefaultDescription
preferLooseListItemBooleantrueThe preferred list type.
bulletListMarkerString-The preferred marker used in bullet list, optional value: -, * +
orderListDelimiterString.The preferred delimiter used in order list, optional value: . )
preferHeadingStyleStringatxThe preferred heading style in MarkText, optional value atx setext, more info
tabSizeNumber4The number of spaces a tab is equal to
listIndentationString1The list indentation of sub list items or paragraphs, optional value dfm, tab or number 1~4
frontmatterTypeString-The frontmatter type: - (YAML), + (TOML), ; (JSON) or { (JSON)
superSubScriptBooleanfalseEnable pandoc's markdown extension superscript and subscript.
footnoteBooleanfalseEnable pandoc's footnote markdown extension
sequenceThemeStringhandChange the theme of js-sequence-diagrams

Theme

KeyTypeDefaultDescription
themeStringlightdark, graphite, material-dark, one-dark, light or ulysses

Editable via file

These entires don't have a settings option and need to be changed manually.

View
KeyTypeDefaultDescription
sideBarVisibility<sup>*</sup>BooleanfalseControls the visibility of the sidebar.
tabBarVisibility<sup>*</sup>BooleanfalseControls the visibility of the tabs.
sourceCodeModeEnabled*BooleanfalseControls the visibility of the source-code editor.

*: These options are default/fallback values that are used if not session is loaded and are overwritten by the menu entries.

File system
KeyTypeDefaultDescription
searchExclusionsArray of Strings[]The filename exclusions for the file searcher. Default: '*.markdown', '*.mdown', '*.mkdn', '*.md', '*.mkd', '*.mdwn', '*.mdtxt', '*.mdtext', '*.mdx', '*.text', '*.txt'
searchMaxFileSizeString""The maximum file size to search in (e.g. 50K or 10MB). Default: unlimited
searchIncludeHiddenBooleanfalseSearch hidden files and directories
searchNoIgnoreBooleanfalseDon't respect ignore files such as .gitignore.
searchFollowSymlinksBooleantrueWhether to follow symbolic links.
watcherUsePollingBooleanfalseWhether to use polling to receive file changes. Polling may leads to high CPU utilization.