NORMAL ~/wkd/p/markdown :set skin=modern utf-8

markdown.nvim

A self-contained Markdown toolkit for Neovim, behind one :Markdown command. Headings and folding, GFM tables, links and references, and a cursor-action dispatcher that opens whatever is under the cursor — all of it FileType-scoped, with no side effects on any buffer that is not Markdown.

status
beta — Beta stage — active development. This repository is past its first shape and in active use, but the surface is not frozen: breaking changes are still possible. Pin a commit or tag if you depend on it.
category
Editing
neovim
0.11+
repo
github.com/WKDSteve/markdown.nvim
commits
402
help
:help markdown

demo

recorded with VHS from demos/markdown.tape in a clean Neovim — re-recorded weekly
what is shown when
  1. :Markdown toc - table of contents + section spacing
  2. :Markdown table format - align a GFM table
  3. :Markdown table view box - floating preview

install

{
  "WKDSteve/markdown.nvim",
  opts = {},
}

docs/

git log

  1. test sheets: links.cwd-speed writes its tree with libuv and a smaller node_modules, inside the 10 s of a case on Windows
  2. test hover: a cut preview page is 1 line plus the marker for a cap of 2, as hover.nvim d1ed18c shows it
  3. test sheets: :Markdown links show cwd measured on 300 notes, node_modules and dot folders left out
  4. perf links, file_refs: list *.md with the lib walker instead of globpath "**"
  5. fix handler: a bare (v1.2) or (example.com) is no file for ma
  6. feat handler: ma on a bare (path) opens that file when the cursor is inside it
  7. test handler: ma and double-click on a link line as a test sheet, with a real path in the parenthesis
  8. fix handler: a src= on a neighbouring line no longer claims a markdown link line
  9. fix handler: ma / double-click opens the link under the cursor, not the first parenthesis
  10. docs graphs: connections through optional loaders, programs, HTTP and files
  11. docs readme: connections to the other repos of the workshop, as a picture and a list
  12. docs readme: the icon of the plugin on top, the files in assets/icons/markdown-nvim

keys

j / k
next / previous line
gg / G
first / last line
⏎
open the line under the cursor
/
search plugins and apps (app: x or plugin: x narrows)
:
command line — Tab completes
:help x
vimdoc of a plugin (:e x = plugin page)
:ls · :apps · :play · :log · :stack
plugin list · app list · play area · activity stream · dependency graph
:log apps
the stream of one area (plugins or apps)
:colo x
colorscheme
:set skin=
modern | tui
?
this help
esc
close