/nvim-github-linker

GithubLink is a Neovim plugin that generates Github links for the current line or selection in your code.

Primary LanguageLuaMIT LicenseMIT

With the help of ChatGPT, I went from having no knowledge of Neovim plugins to being able to write all the code and README.

GithubLink

GithubLink is a Neovim plugin that allows you to generate a GitHub link to the current line or selected code in your Neovim editor. It's a handy tool for sharing code snippets with others or quickly jumping to a specific line in your repository on GitHub.

Installation

To install GithubLink, you can use your preferred plugin manager for Neovim. Here's an example using the packer.nvim plugin manager:

use {
    "vincent178/neovim-github-linker",
    config = function()
        require("neovim-github-linker").setup()
    end,
}

Usage

Once GithubLink is installed, you can use it by running the :GithubLink command in Normal mode, or by using the : command in Visual mode to select a range of code and generate a link.

To customize the behavior of GithubLink, you can pass options to the setup() function. Here's an example:

require("github-linker").setup({
    mappings = true,
    default_remote = "origin",
    copy_to_clipboard = true,
})
  • mappings: If set to true, GithubLink will create default mappings for the :GithubLink command in Normal mode and the : command in Visual mode. Default value is true.
  • default_remote: The default Git remote to use when generating links. Default value is "origin".
  • copy_to_clipboard: If set to true, GithubLink will copy the generated link to the system clipboard. Default value is true.

License

GithubLink is released under the MIT license. See the LICENSE file for more details.