docs: add snacks.nvim mention to readme
This commit is contained in:
Kristofers Solo
parent
67beb093c5
commit
32e76da1b1
2 changed files with 48 additions and 55 deletions
|
|
@ -1,38 +1,35 @@
|
||||||
http-codes *http-codes.txt*
|
http-codes *http-codes.txt*
|
||||||
|
|
||||||
Author: Barrett Ruth <https://barrettruth.com>
|
Author: Barrett Ruth <https://barrettruth.com>
|
||||||
Homepage: <https://github.com/barrett-ruth/http-codes.nvim>
|
Homepage: <https://github.com/barrettruth/http-codes.nvim>
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
INTRODUCTION *http-codes.nvim*
|
INTRODUCTION *http-codes.nvim*
|
||||||
|
|
||||||
https-codes.nvim lets you quickly investigate HTTP status codes with mozilla,
|
http-codes.nvim lets you quickly investigate HTTP status codes with Mozilla,
|
||||||
supporting fzf-lua and telescope.nvim.
|
supporting fzf-lua, snacks.nvim, and telescope.nvim.
|
||||||
|
|
||||||
Author: Barrett Ruth <https://barrettruth.com>
|
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
SETUP *http-codes.setup()*
|
CONFIGURATION *http-codes.config*
|
||||||
>lua
|
|
||||||
require('http-codes').setup(config)
|
|
||||||
<
|
|
||||||
Parameters: ~
|
|
||||||
|
|
||||||
{config} `(table)`: table containing configuration for http-codes.
|
Configure via `vim.g.http_codes` before the plugin loads:
|
||||||
Defaults shown below.
|
|
||||||
|
|
||||||
Usage: ~
|
|
||||||
>lua
|
>lua
|
||||||
require('http-codes').setup({
|
vim.g.http_codes = {
|
||||||
-- defaults to available picker: 'fzf-lua' or 'telescope'
|
use = 'fzf-lua',
|
||||||
use = 'fzf-lua'
|
open_url = 'xdg-open %s',
|
||||||
-- How the mozilla url is opened.
|
}
|
||||||
-- Configured by default based on OS:
|
|
||||||
open_url = 'xdg-open %s' -- UNIX
|
|
||||||
-- = 'open %s' -- OSX
|
|
||||||
-- = 'start %s' -- Windows
|
|
||||||
})
|
|
||||||
<
|
<
|
||||||
|
Options: ~
|
||||||
|
|
||||||
|
{use} `(string|nil)`: Picker to use: 'fzf-lua', 'snacks', or
|
||||||
|
'telescope'. Auto-detected if not specified.
|
||||||
|
|
||||||
|
{open_url} `(string|nil)`: Command to open URLs. Uses `%s` as placeholder.
|
||||||
|
Defaults based on OS:
|
||||||
|
- Linux: 'xdg-open %s'
|
||||||
|
- macOS: 'open %s'
|
||||||
|
- Windows: 'start %s'
|
||||||
|
|
||||||
===============================================================================
|
===============================================================================
|
||||||
COMMANDS *http-codes.commands*
|
COMMANDS *http-codes.commands*
|
||||||
|
|
||||||
|
|
|
||||||
58
readme.md
58
readme.md
|
|
@ -1,51 +1,47 @@
|
||||||
# http-codes.nvim
|
# http-codes.nvim
|
||||||
|
|
||||||
Quickly investigate HTTP status codes with the help of [mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP), including [telescope](https://github.com/barrett-ruth/telescope-http.nvim/) and [fzf-lua](https://github.com/ibhagwan/fzf-lua) integrations.
|
Quickly investigate HTTP status codes with the help of [Mozilla](https://developer.mozilla.org/en-US/docs/Web/HTTP), with telescope, fzf-lua, and snacks.nvim integrations.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Install via your favorite package manager, like [lazy](https://github.com/folke/lazy.nvim):
|
Install using your package manager of choice or via [luarocks](https://luarocks.org/modules/barrettruth/http-codes.nvim):
|
||||||
|
|
||||||
```lua
|
```
|
||||||
require('lazy').setup({
|
luarocks install http-codes.nvim
|
||||||
{
|
|
||||||
'barrett-ruth/http-codes.nvim',
|
|
||||||
config = true,
|
|
||||||
-- or 'nvim-telescope/telescope.nvim'
|
|
||||||
dependencies = 'ibhagwan/fzf-lua'
|
|
||||||
keys = { { '<leader>H', '<cmd>HTTPCodes<cr>' }}
|
|
||||||
}
|
|
||||||
})
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## [Configuration](./doc/http-codes.txt)
|
## Dependencies
|
||||||
|
|
||||||
`http-codes.nvim` uses telescope or fzf-lua (whichever you've installed), which can be manually overidden.
|
One of:
|
||||||
|
- [fzf-lua](https://github.com/ibhagwan/fzf-lua)
|
||||||
|
- [snacks.nvim](https://github.com/folke/snacks.nvim)
|
||||||
|
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
|
||||||
|
|
||||||
`http-codes.nvim` opens the Mozilla documentation URLs based on your operating system. This can be overidden.
|
## Configuration
|
||||||
|
|
||||||
| OS | open_url |
|
Configure via `vim.g.http_codes` before the plugin loads:
|
||||||
| ------- | ------------- |
|
|
||||||
| Windows | `start %s` |
|
|
||||||
| OSX | `open %s` |
|
|
||||||
| UNIX | `xdg-open %s` |
|
|
||||||
|
|
||||||
See [the docs](./doc/http-codes.txt) for more information.
|
```lua
|
||||||
|
vim.g.http_codes = {
|
||||||
|
use = 'fzf-lua', -- or 'snacks' or 'telescope', auto-detected by default
|
||||||
|
open_url = 'xdg-open %s', -- OS-specific by default
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
| OS | Default open_url |
|
||||||
|
| ------- | ---------------- |
|
||||||
|
| Windows | `start %s` |
|
||||||
|
| macOS | `open %s` |
|
||||||
|
| Linux | `xdg-open %s` |
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use the exposed command in vimscript:
|
```vim
|
||||||
|
|
||||||
```lua
|
|
||||||
:HTTPCodes
|
:HTTPCodes
|
||||||
```
|
```
|
||||||
|
|
||||||
or in lua:
|
## Documentation
|
||||||
|
|
||||||
```lua
|
```vim
|
||||||
require('http-codes').http_codes()
|
:help http-codes.nvim
|
||||||
```
|
```
|
||||||
|
|
||||||
## Migration
|
|
||||||
|
|
||||||
If migrating from [telescope-http.nvim](https://github.com/barrett-ruth/telescope-http.nvim), follow the above instructions—no telescope-specific config is necessary.
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue