From e52b149d4df3cccc8a08a300d9da1ce61f490693 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 17 Apr 2023 17:43:30 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/open-github-url.nvim.txt | 73 ++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/doc/open-github-url.nvim.txt b/doc/open-github-url.nvim.txt index e69de29..10780c7 100644 --- a/doc/open-github-url.nvim.txt +++ b/doc/open-github-url.nvim.txt @@ -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 + +>viml + Plug 'tetzng/open-githhub-url.nvim' +< + +Using dein + +>viml + call dein#add('tetzng/open-githhub-url.nvim') +< + +Using 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 + +vim:tw=78:ts=8:noet:ft=help:norl: