vim-markdown-navigation/README.md
2024-10-01 19:14:47 -07:00

1.1 KiB

vim-markdown-navigation

Enable navigation of in-document links in Vim editor for Markdown documents.

This plugin is intended to work in conjunction with vim-markdown but will work standalone as well.

Installation

Copy markdown.vim to ~/.vim/after/ftplugin/

Testing

A useful document to test this with is README.md with TOC by ekalinin

Usage

Simply move the cursor over a link and press K (shift-k).

For convenient generation of tables of contents for Markdown documents the following are recommended:

vim-markdown-toc - Vim plugin capable of generating tables of contents in GitHub, GitLab, and Redcarpet flavored markdown.

github-markdown-toc - Standalone program with many features that generates tables of contents.

Authors

User novum on freenode IRC channel #vim

Credits

All of the helpful people on the freenode #vim channel.