Reflow Markdown

Reflow Markdown is a Visual Studio Code Extension originally forked from the Reflow paragraph extension by Troels Damgaard. Instead of targeting any line of text, however it focuses on Markdown files only and the specific formatting constructs unique to it such as paragraphs, headings, block quotes, lists, and code blocks.

Format the current heading, paragraph, list, or blockquote to have lines no longer than your preferred line length, using the alt+q shortcut or your own user-specific keyboard-binding.

Alternatively, you can use the extension as a formatter for Markdown files. This lets you reflow the entire document or a selected range using the built-in Format Document command.

When installed, this extension sets itself as the default Markdown formatter unless you already have one configured.

This extension defaults to reflowing lines to be no more than 80 characters long. The preferred line length may be overridden using the config value of reflowMarkdown.preferredLineLength.

Setup

To automatically reformat Markdown files on save, add the following to your user or workspace settings:

"[markdown]": {
    "editor.defaultFormatter": "marvhen.reflow-markdown",
    "editor.formatOnSave": true
}

To manually trigger formatting, set formatOnSave to false and use the Format Document command from the Command Palette (default shortcut: shift+alt+f).

Extension Settings

This extension contributes the following settings:

• reflowMarkdown.preferredLineLength: Set the preferred line length for reflowing paragraph (default: 80).

• reflowMarkdown.doubleSpaceBetweenSentences: Insert two spaces instead of one between each sentence (default false).

• reflowMarkdown.resizeHeaderDashLines: Modifies the length of the ---'s or ==='s under H1s and H2s to be the same length as the header text. If the header text spans multiple lines, the dashes are set to be the length of the longest line.

• reflowMarkdown.wrapLongLinks: Specifies how links will be wrapped when they cause a line to extend beyond the preferred length.

• reflowMarkdown.neverReflowFirstParagraph: Never reflow the first paragraph of a document (default false).

Keyboard Shortcuts

• Invoke a reflow using alt+q (default).