Question 1

How do I install gitlinker.nvim with lazy.nvim?

Accepted Answer

The README provides a lazy.nvim snippet: add the plugin with 'cmd = "GitLink"' and optional key mappings. You need to specify opts or use the setup function, and ensure Neovim ≥ 0.10 is installed.

Question 2

What's the difference between gitlinker.nvim and vim-fugitive's GBrowse?

Accepted Answer

gitlinker.nvim is a Lua-based fork focused on customization and modern Neovim features, offering more router types and async processing. Fugitive's GBrowse is Vim script-based with broader git integration but less flexibility for URL generation.

Question 3

Can it generate links for a specific commit hash?

Accepted Answer

Yes, use the 'rev' parameter in commands or API, e.g., 'GitLink rev=00b3f9a1' to create permalinks for any commit, not just the current HEAD, as explained in the 'Commit ID' section.

Question 4

How to set up SSH host alias support?

Accepted Answer

The plugin automatically respects SSH aliases configured in ~/.ssh/config, resolving them to correct URLs during link generation, provided ssh is installed and accessible.

Question 5

Does it work with enterprise GitHub instances?

Accepted Answer

Yes, by customizing the router in setup: bind your enterprise host pattern to github_browse or github_blame functions, or use string templates to match internal URLs, as shown in the examples.

Question 6

What are the router types and when should I use them?

Accepted Answer

Router types include browse (default blob links), blame (for code history), default_branch, and current_branch. Use browse for sharing code, blame for debugging, and branch types for stable or development references.

gitlinker.nvim

What is gitlinker.nvim?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions