Verified Commit 04ff5e84 authored by Marco's avatar Marco

Add basic help file

parent c7624d68
*OpenUrl.txt* A Vim/Neovim plugin to open URLs in your default browser.
Author: Marco Kellershoff <https://walialu.com/>
License: MIT License (see |license|)
INTRODUCTION *OpenUrl*
This plugin's main purpose is to open URLs under your cursor (
or fall-back to [investigate.vim](https://github.com/keith/investigate.vim),
when `OpenUrl#GetUrl()` can't find a valid URL.
COMMANDS *OpenUrl-commands*
There are no commands registered by the plugin.
MAPPINGS *OpenUrl-mappings*
There are no mappings registered by the plugin.
You need to map it according to your preference.
*OpenUrl#UnderCursor()*
Tries to extract an URL with the help of `OpenUrl#GetWordUnderCursor()` and
`OpenUrl#GetUrl(word)`, then it passes the URL to
`OpenUrl#WithDefaultBrowser(url)` which opens the URL with your default browser
or, if `OpenUrl#GetUrl(word)` fails to extract a URL,
falls back to `investigate#Investigate())` if `g:OpenUrl_DarkInvestigate`
is set.
*OpenUrl#WithApp(...)*
The first parameter is the name of the binary, e.g. `google-chrome-stable`
and the second parameter is the `path` or `url`.
ABOUT *OpenUrl-about*
Grab the latest version or report a bug on GitHub:
http://github.com/superevilmegaco/OpenUrl.nvim
vim:tw=78:et:ft=help:norl:
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment