How do I change the key mapping for follow-md-links.nvim?

You can override the default mapping by setting a custom keymap in your Neovim configuration. For example, use vim.keymap.set to map a different key to the plugin's function, but check the README for specific Lua examples.

Does follow-md-links.nvim work with lazy loading in Neovim?

Yes, the plugin supports lazy loading via package managers like Lazy.nvim. You can add it to your setup with the provided configuration snippet to load only when editing markdown files for efficiency.

What should I do if a markdown link doesn't open correctly?

Ensure the link format matches supported types (e.g., web links must start with http/https). For file paths, verify they are accessible and correctly relative to the current file, as the plugin handles absolute and relative paths.

Can follow-md-links.nvim handle links with special characters or spaces?

The README doesn't specify, but typical markdown parsing should handle encoded spaces or special characters. However, complex paths might require proper escaping, similar to standard markdown behavior in Neovim.

follow-md-links.nvim vs. other markdown plugins like vim-markdown: which is better for link navigation?

follow-md-links.nvim focuses solely on link following with precise cursor placement, while vim-markdown offers broader syntax support. Choose this plugin if you need dedicated, efficient link navigation without extra features.

How to open web links in a specific browser instead of the default?

The plugin uses the system's default browser; to change this, you'd need to configure Neovim's external command handling or override the plugin's web link opening logic, which isn't documented in the README.

Open-Awesome

follow-md-links.nvim

GPL-3.0Lua

A Neovim plugin that enables easy navigation of markdown links by pressing Enter on any link.

GitHub

175 stars29 forks0 contributors

What is follow-md-links.nvim?

follow-md-links.nvim is a Neovim plugin that allows users to navigate markdown links by pressing Enter when the cursor is on a link. It supports various link types including file paths, web URLs, and reference links, opening them directly in Neovim or the default browser. It solves the problem of manually copying and opening links while editing markdown files.

Target Audience

Neovim users who frequently work with markdown files, such as developers writing documentation, technical writers, or note-takers.

Value Proposition

It provides a fast, keyboard-driven way to follow links without leaving the editor, reducing context switching and improving workflow efficiency compared to manual methods.

Overview

Easily follow markdown links with this neovim plugin

Use Cases

Best For

Navigating local documentation with internal file links
Following web references from markdown notes
Jumping to specific lines or headings in linked files
Working with markdown-based wikis or knowledge bases
Editing technical documentation with cross-references
Quickly accessing man pages or URI links from markdown

Not Ideal For

Users working extensively with non-markdown file formats (e.g., HTML, LaTeX) that require similar link navigation
Projects needing advanced link management features like validation, broken link detection, or batch processing
Environments where Neovim is not the primary editor or cross-editor compatibility is essential
Teams requiring support for custom web protocols beyond http/https (e.g., ftp, mailto)

Pros & Cons

Pros

Comprehensive Link Support

Handles a wide range of markdown link types including absolute/relative file paths, reference links, heading links, man pages, and URIs, as listed in the README.

Precise Cursor Placement

Supports file paths with line numbers or headings to place the cursor exactly at the specified location, similar to Neovim's gF command for efficient navigation.

Minimal Configuration

Comes with a default <cr> mapping in normal mode for instant use, and setup is straightforward with popular package managers like Packer or Lazy.nvim.

Seamless Browser Integration

Automatically opens web links in the default browser, reducing context switching when following external references from markdown files.

Cons

Limited Web Protocol Support

Only identifies web links starting with http:// or https://, missing support for other protocols like ftp or custom URIs, which can be restrictive for diverse use cases.

Neovim Version Dependency

Tested only against the latest stable Neovim version, potentially causing compatibility issues with older releases or development builds, as noted in the README.

Potential Key Conflicts

The default <cr> mapping in normal mode might interfere with other plugins or native Neovim functions, especially in markdown-heavy workflows without custom remapping.

Frequently Asked Questions

Related Projects

markdown-preview.nvim

markdown preview plugin for (neo)vim

Stars8,017

Forks415

Last commit2 years ago

render-markdown.nvim

Improve viewing Markdown in Neovim

Stars5,181

Forks147

Last commit12 days ago

markview.nvim

A hackable markdown, Typst, latex, html(inline) & Asciidoc previewer for Neovim

Stars3,667

Forks111

Last commit5 days ago

peek.nvim

Markdown preview plugin for Neovim

Stars877

Forks93