Marxdown
日本語English
Download

Guide

Settings

Every setting, in the same order as the Settings screen (Ctrl+,).

Listed in the same order as the Settings screen (Ctrl+,). When editing settings.json directly, use the key of each setting (e.g. preview.fontSize). Open settings.json from “Open settings.json” in Settings.

Application

  • Appearance

    theme

    Switches between light and dark. Choose the colors in Color Theme, separately for the preview and the editor.

    Default
    System
    Options
    • Systemsystem
    • Lightlight
    • Darkdark

  • Display Language

    ui.language

    The language of the app. Automatic follows the display language of the OS. Takes effect after you quit and reopen the app.

    Default
    Automatic
    Options
    • Automaticauto
    • 日本語ja
    • Englishen

  • Keep Running in the Tray on Close

    window.closeToTray

    Closing the window keeps the app running in the system tray, so it opens instantly the next time.

    Default
    On

  • Start in the Tray at Login

    window.launchAtLogin

    Makes even the first launch of the day instant. Works only when Keep Running in the Tray on Close is on.

    Default
    Off

  • Check for Updates Automatically

    update.autoCheck

    Checks at startup and when the window comes to the front, at most once a day.

    Default
    On

Preview

  • Color Theme

    preview.theme

    Choose from 50 built-in themes and the CSS files in the themes folder.

    Default
    Marxdown

  • Text Font

    preview.fontFamily

    The name of an installed font. If the font is not found, the default font is used.

    Default
    Default font

  • Code Font

    preview.codeFontFamily

    The name of an installed font. If the font is not found, the default font is used.

    Default
    Default font

  • Font Size

    preview.fontSize

    The size of the text, in px.

    Default
    16
    Range
    8–72

  • Line Height

    preview.lineHeight

    The height of a line, as a multiple of the font size.

    Default
    1.75
    Range
    1–3

  • Text Width

    preview.maxWidth

    The maximum number of characters on a line, counted in half-width characters.

    Default
    72
    Range
    20–200

  • Keep Line Breaks in Paragraphs

    preview.softBreak

    Shows line breaks inside a paragraph as they are. When off, lines are joined until a blank line separates them.

    Default
    Off

  • Front Matter

    preview.frontMatter

    How the YAML fenced with --- at the top of a document is shown.

    Default
    Table
    Options
    • Tabletable
    • YAMLcode
    • Hiddenhidden

  • Table Borders

    preview.tableStyle

    How table borders are drawn. For tables with many columns, a grid or stripes make rows easier to follow.

    Default
    Horizontal Lines Only
    Options
    • Horizontal Lines Onlylines
    • Gridgrid
    • Stripeszebra

Editor

  • Color Theme

    editor.theme

    Choose from 50 built-in themes and the CSS files in the themes folder.

    Default
    Marxdown

Font

  • Font Family

    editor.fontFamily

    The name of an installed font. If the font is not found, the default font is used.

    Default
    Default font

  • Font Size

    editor.fontSize

    The size of the text, in px.

    Default
    14
    Range
    8–72

  • Line Height

    editor.lineHeight

    The height of a line, as a multiple of the font size.

    Default
    1.6
    Range
    1–3

  • Letter Spacing

    editor.letterSpacing

    The spacing between characters, in px.

    Default
    0
    Range
    -2–10

  • Font Ligatures

    editor.fontLigatures

    Shows character sequences such as "->" and "!=" as a single symbol. Works only with fonts that support it.

    Default
    On

Display

  • Line Numbers

    editor.lineNumbers
    Default
    On
    Options
    • Offoff
    • Onon
    • Relative to Cursorrelative
    • Every 10 Linesinterval

  • Whitespace

    editor.renderWhitespace
    Default
    None
    Options
    • Nonenone
    • Except Between Wordsboundary
    • In Selection Onlyselection
    • Trailing Onlytrailing
    • Allall

  • Current Line Highlight

    editor.renderLineHighlight
    Default
    Whole Line
    Options
    • Nonenone
    • Line Number Onlygutter
    • Whole Lineline
    • Bothall

  • Control Characters

    editor.renderControlCharacters

    Shows control characters as symbols.

    Default
    On

  • Indentation Guides

    editor.guides.indentation

    Shows vertical lines at indentation levels.

    Default
    On

  • Bracket Pair Colorization

    editor.bracketPairColorization.enabled

    Colors matching brackets by pair.

    Default
    Off

  • Minimap

    editor.minimap.enabled

    Shows a zoomed-out view of the whole document on the right edge of the editor.

    Default
    Off

  • Sticky Headings

    editor.stickyScroll.enabled

    While scrolling, keeps the heading of the current section at the top of the editor.

    Default
    On

  • Rulers

    editor.rulers

    Draws vertical lines at the given columns. Separate multiple columns with commas. The color of each line can be set in settings.json.

    Default
    (empty)

  • Top Padding

    editor.padding.top

    The space between the top of the editor and the first line, in px.

    Default
    12
    Range
    0–100

Input and Navigation

  • Word Wrap

    editor.wordWrap
    Default
    At Window Width
    Options
    • Offoff
    • At Window Widthon
    • At ColumnwordWrapColumn
    • At Window Width or Column, Whichever Is Narrowerbounded

  • Wrap Column

    editor.wordWrapColumn

    The column to wrap at, counted in half-width characters.

    Default
    80
    Range
    20–500

  • Wrap Indicator

    editor.wordWrapIndicator

    Shows a symbol at the end of wrapped lines to tell them apart from real line breaks.

    Default
    Off

  • Tab Size

    editor.tabSize

    The width of a tab, in spaces.

    Default
    2
    Range
    1–8

  • Insert Spaces for Tab

    editor.insertSpaces

    Inserts spaces instead of a tab character when you press Tab.

    Default
    On

  • Word Separators

    editor.wordSeparators

    Characters treated as word boundaries when moving by word, such as with Ctrl+← and Ctrl+→.

    Default
    `~!@#$%^&*()-=+[{]}\|;:'",.<>/?

  • Word Segmentation Languages

    editor.wordSegmenterLocales

    Languages used to find word boundaries in text without spaces between words, such as Japanese. Used when moving by word and when selecting with a double-click. Separate multiple languages with commas. When empty, only the word separators are used.

    Default
    ja

  • Pasted Image Folder

    editor.pasteImage.directory

    The folder where pasted images are saved, relative to the document's folder. ${documentFileName} is replaced with the document's file name, and ${documentBaseName} with the file name without its extension. Leave it empty to save next to the document. Folders outside the document's folder cannot be used.

    Default
    ${documentFileName}.assets

  • Cursor Style

    editor.cursorStyle
    Default
    Line
    Options
    • Lineline
    • Blockblock
    • Underlineunderline
    • Thin Lineline-thin
    • Block Outlineblock-outline
    • Thin Underlineunderline-thin

  • Cursor Blinking

    editor.cursorBlinking
    Default
    Blink
    Options
    • Blinkblink
    • Smoothsmooth
    • Fadephase
    • Expandexpand
    • Solidsolid

  • Cursor Surrounding Lines

    editor.cursorSurroundingLines

    The minimum number of lines kept visible above and below the cursor when scrolling.

    Default
    0
    Range
    0–30

  • Scroll Beyond Last Line

    editor.scrollBeyondLastLine

    Allows scrolling until the last line reaches the top of the editor.

    Default
    On

Syntax

  • Abbreviations

    markdown.abbreviations

    Shows the definition of terms defined as "*[HTML]: HyperText Markup Language".

    Default
    Off

  • Definition Lists

    markdown.definitionLists

    Shows a term followed by a line starting with ": " as a definition list.

    Default
    Off

  • Insertions

    markdown.insertions

    Shows "++text++" as inserted text, underlined.

    Default
    Off

  • Highlights

    markdown.marks

    Shows "==text==" as if marked with a highlighter.

    Default
    Off

  • Multiline Tables

    markdown.multilineTables

    Enables a table syntax that allows line breaks inside cells.

    Default
    Off

  • Subscript

    markdown.subscript

    Shows the "2" in "H~2~O" as subscript.

    Default
    Off

  • Superscript

    markdown.superscript

    Shows the "2" in "x^2^" as superscript.

    Default
    Off

  • Marp Themes

    marp.themes

    Absolute paths of CSS files or folders with themes that slides can select with theme:. Separate multiple paths with commas.

    Default
    (empty)

Explorer

  • Excluded Paths

    explorer.exclude

    Glob patterns (with wildcards such as *) for paths hidden from the Explorer and Go to File. Separate multiple patterns with commas. A pattern without / matches the name at any level. Hidden files and node_modules are always hidden.

    Default
    (empty)

  • Open Clicked Files in a Temporary Tab

    explorer.temporaryTab

    A temporary tab shows its name in italics and is replaced when you click another file. It becomes a regular tab when you edit it or double-click it.

    Default
    On

Outline

  • Heading Levels

    outline.maxDepth

    The deepest heading level shown in the Outline, from 1 to 6. Deeper headings are not shown.

    Default
    6
    Range
    1–6

Adding your own color theme

Each .css file in the themes folder becomes a color theme and appears in Color Theme in Settings. It can be selected for both the preview and the editor. The theme name is the file name without the extension (only letters, digits, - and _).

Write only declarations in the file, without selectors. Use light-dark() for different colors in light and dark, and color-scheme for a theme that supports only one of them. A file with the same name as a built-in theme is used instead of it. Changes take effect as soon as you save the file.

Location

%APPDATA%\com.antimacho612.marxdown\themes\<name>.css
--mx-color-bg: light-dark(#ffffff, #101010);
--mx-color-fg: light-dark(#1c2024, #edeef0);
--mx-color-code-string: #0f766e;

Variables

Background
--mx-color-bg--mx-color-bg-subtle--mx-color-bg-inset--mx-color-bg-hover
Text
--mx-color-fg--mx-color-fg-muted--mx-color-fg-subtle
Borders
--mx-color-border--mx-color-border-subtle
Accent
--mx-color-accent
Code
--mx-color-code-comment--mx-color-code-keyword--mx-color-code-string--mx-color-code-number--mx-color-code-function--mx-color-code-variable--mx-color-code-builtin
↑↓ to select · Enter to go · Esc to close