Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 17, 2023
1 parent d5729aa commit e52b149
Showing 1 changed file with 73 additions and 0 deletions.
73 changes: 73 additions & 0 deletions doc/open-github-url.nvim.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
*open-github-url.nvim.txt* For NVIM v0.8.0 Last change: 2023 April 17

==============================================================================
Table of Contents *open-github-url.nvim-table-of-contents*

1. open-githhub-url.nvim |open-github-url.nvim-open-githhub-url.nvim|
- Installation |open-github-url.nvim-open-githhub-url.nvim-installation|
- Features |open-github-url.nvim-open-githhub-url.nvim-features|
- Usage |open-github-url.nvim-open-githhub-url.nvim-usage|
- Setup |open-github-url.nvim-open-githhub-url.nvim-setup|

==============================================================================
1. open-githhub-url.nvim *open-github-url.nvim-open-githhub-url.nvim*

**open-githhub-url.nvim** is a Neovim plugin to open the abbreviated GitHub
repository URL under the cursor in your browser.


INSTALLATION *open-github-url.nvim-open-githhub-url.nvim-installation*

Using vim-plug <https://github.com/junegunn/vim-plug>

>viml
Plug 'tetzng/open-githhub-url.nvim'
<

Using dein <https://github.com/Shougo/dein.vim>

>viml
call dein#add('tetzng/open-githhub-url.nvim')
<

Using packer.nvim <https://github.com/wbthomason/packer.nvim>

>lua
use 'tetzng/open-githhub-url.nvim'
<


FEATURES *open-github-url.nvim-open-githhub-url.nvim-features*


- Open GitHub repository URL with the repository path under the cursor
- Get the repository path detected under the cursor
- Open a specific URL in the default web browser


USAGE *open-github-url.nvim-open-githhub-url.nvim-usage*

Open a GitHub URL under the cursor: `:OpenGitHubUrlUnderCursor` This command
opens the GitHub repository URL with the repository path under the cursor.

Get the repository path under the cursor: `:GetRepoPathUnderCursor` This
command prints the repository path detected under the cursor.

Open a specific URL: `:OpenUrl https://github.com/user/repo` This command opens
the given URL in the default web browser.


SETUP *open-github-url.nvim-open-githhub-url.nvim-setup*

To set up the plugin, simply call its `setup()` function, typically in your
`init.lua` configuration file:

>lua
require('open-github-url').setup()
<

This will create the user commands described in the usage section.

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl:

0 comments on commit e52b149

Please sign in to comment.