Nev

Markdown

Nev includes built-in support for editing markdown files with visual formatting, text toggles, and inline image rendering. This is disabled by default. See the configuration section at the end on how to enable it.

Visual Formatting

Markdown files get several automatic rendering features that make the raw source easier to read without changing the file content.

Table Alignment

Pipe tables are automatically aligned by adding invisible padding overlays so that columns line up visually. The actual file content is not modified.

A markdown file with a pipe table before and after alignment, showing how columns are padded so they line up evenly

Delimiter Hiding

Formatting markers like *, _, `, and ~ are hidden when your cursor is not on that line. The markers reappear as soon as you move your cursor to that line.

Two views of the same markdown file: left shows delimiters visible with cursor on an emphasis line, right shows delimiters hidden with cursor on a different line

Header Marker Hiding

The # markers on heading lines are hidden when your cursor is not on that line. Instead, a subtle line is rendered below the heading to visually distinguish it.

Two views: left shows `#` markers visible with cursor on a header line, right shows markers hidden and a subtle underline rendered below the heading

Toggle Commands

Four commands are available for toggling inline formatting on the current selection or word. If the selection already has the style, it is removed. If not, it is wrapped. If a different style is present, it is converted.

Command Style Wraps with
markdown.toggle-bold Bold **
markdown.toggle-italic Italic *
markdown.toggle-code Code `
markdown.toggle-strikethrough Strikethrough ~

When toggling with an empty selection (just a cursor), the surrounding word is used. After toggling, tab stops are set up so you can cycle between the opening and closing delimiters.

A gif showing text being selected and `markdown.toggle-bold` applied to wrap with `**`, then `markdown.toggle-italic` to convert to `*`, then applied again to remove the style entirely

These commands are not bound to any key by default. Bind them in your keybindings.json under the appropriate input mode. See Keybindings for full details on the keybinding system.

// ~/.nev/keybindings.json
{
    "vim.normal": {
        "<C-b>": "markdown.toggle-bold",
        "<C-i>": "markdown.toggle-italic",
        "<C-c>": "markdown.toggle-code",
        "<C-s>": "markdown.toggle-strikethrough"
    }
}

Inline Images

The markdown plugin renders images inline in the editor for image links in the format ![alt](path).

Supported formats: PNG, JPEG, GIF, BPM, QOI, PPM.

A markdown file containing image links where the images are rendered directly inline in the editor below the link text

Animated GIFs

Animated GIFs are also supported:

A gif showing an animated GIF being rendered and playing inside a markdown editor

Image Commands

Command Description
markdown.change-image-scale Multiply the current image scale by a factor (e.g. 0.5 to halve, 2 to double)
markdown.set-image-scale Set the image scale to an absolute value
markdown.clear-image-cache Clear cached image textures, forcing them to be reloaded

The image scale persists across sessions.

Path Remaps

If your image paths don’t resolve correctly (e.g. because they reference paths from another tool), you can remap them using plugin.markdown.path-remaps in your settings:

{
    "plugin.markdown.path-remaps": [
        ["/original/path/prefix", "/mapped/path/prefix"]
    ]
}

Each remap is a pair of [source, destination]. If an image path starts with the source prefix, that prefix is replaced with the destination prefix.

Configuration

Enabling for Other Languages

By default the markdown visual features (table alignment, delimiter hiding, header hiding, toggle commands) not active. To enable them set markdown.languages in your settings:

{
    "markdown.languages": ["markdown"]
}

Use ["*"] to enable for all languages.

Language Settings

The markdown language configuration (in the default settings.json) sets:

This site is open source. Improve this page.