|
| 1 | +*open-github-url.nvim.txt* For NVIM v0.8.0 Last change: 2023 April 17 |
| 2 | + |
| 3 | +============================================================================== |
| 4 | +Table of Contents *open-github-url.nvim-table-of-contents* |
| 5 | + |
| 6 | +1. open-githhub-url.nvim |open-github-url.nvim-open-githhub-url.nvim| |
| 7 | + - Installation |open-github-url.nvim-open-githhub-url.nvim-installation| |
| 8 | + - Features |open-github-url.nvim-open-githhub-url.nvim-features| |
| 9 | + - Usage |open-github-url.nvim-open-githhub-url.nvim-usage| |
| 10 | + - Setup |open-github-url.nvim-open-githhub-url.nvim-setup| |
| 11 | + |
| 12 | +============================================================================== |
| 13 | +1. open-githhub-url.nvim *open-github-url.nvim-open-githhub-url.nvim* |
| 14 | + |
| 15 | +**open-githhub-url.nvim** is a Neovim plugin to open the abbreviated GitHub |
| 16 | +repository URL under the cursor in your browser. |
| 17 | + |
| 18 | + |
| 19 | +INSTALLATION *open-github-url.nvim-open-githhub-url.nvim-installation* |
| 20 | + |
| 21 | +Using vim-plug <https://github.com/junegunn/vim-plug> |
| 22 | + |
| 23 | +>viml |
| 24 | + Plug 'tetzng/open-githhub-url.nvim' |
| 25 | +< |
| 26 | + |
| 27 | +Using dein <https://github.com/Shougo/dein.vim> |
| 28 | + |
| 29 | +>viml |
| 30 | + call dein#add('tetzng/open-githhub-url.nvim') |
| 31 | +< |
| 32 | + |
| 33 | +Using packer.nvim <https://github.com/wbthomason/packer.nvim> |
| 34 | + |
| 35 | +>lua |
| 36 | + use 'tetzng/open-githhub-url.nvim' |
| 37 | +< |
| 38 | + |
| 39 | + |
| 40 | +FEATURES *open-github-url.nvim-open-githhub-url.nvim-features* |
| 41 | + |
| 42 | + |
| 43 | +- Open GitHub repository URL with the repository path under the cursor |
| 44 | +- Get the repository path detected under the cursor |
| 45 | +- Open a specific URL in the default web browser |
| 46 | + |
| 47 | + |
| 48 | +USAGE *open-github-url.nvim-open-githhub-url.nvim-usage* |
| 49 | + |
| 50 | +Open a GitHub URL under the cursor: `:OpenGitHubUrlUnderCursor` This command |
| 51 | +opens the GitHub repository URL with the repository path under the cursor. |
| 52 | + |
| 53 | +Get the repository path under the cursor: `:GetRepoPathUnderCursor` This |
| 54 | +command prints the repository path detected under the cursor. |
| 55 | + |
| 56 | +Open a specific URL: `:OpenUrl https://github.com/user/repo` This command opens |
| 57 | +the given URL in the default web browser. |
| 58 | + |
| 59 | + |
| 60 | +SETUP *open-github-url.nvim-open-githhub-url.nvim-setup* |
| 61 | + |
| 62 | +To set up the plugin, simply call its `setup()` function, typically in your |
| 63 | +`init.lua` configuration file: |
| 64 | + |
| 65 | +>lua |
| 66 | + require('open-github-url').setup() |
| 67 | +< |
| 68 | + |
| 69 | +This will create the user commands described in the usage section. |
| 70 | + |
| 71 | +Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> |
| 72 | + |
| 73 | +vim:tw=78:ts=8:noet:ft=help:norl: |
0 commit comments