Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lalitmee/browse.nvim
browse for anything using your choice of method
https://github.com/lalitmee/browse.nvim
Last synced: 2 days ago
JSON representation
browse for anything using your choice of method
- Host: GitHub
- URL: https://github.com/lalitmee/browse.nvim
- Owner: lalitmee
- License: mit
- Created: 2022-03-13T13:03:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T20:25:53.000Z (about 2 months ago)
- Last Synced: 2024-10-29T22:56:54.652Z (11 days ago)
- Language: Lua
- Size: 1.05 MB
- Stars: 179
- Watchers: 3
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# browse.nvim
##### browse for anything using your choice of method
[](http://www.lua.org)
[](https://github.com/lalitmee/browse.nvim/blob/main/LICENSE)
## Features
- cross platform
- reduces your search key strokes for any stackoverflow query
- [devdocs](https://devdocs.io) search
- [MDN](https://developer.mozilla.org/en-US/) search
## Requirements
- [neovim](https://github.com/neovim/neovim) (0.7.0+)
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
- open cmd
- [xdg-open](https://linux.die.net/man/1/xdg-open) (linux)
- [wsl-open](https://github.com/4U6U57/wsl-open) (wsl)
- [open](https://ss64.com/osx/open.html) (mac)
- [start](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/start) (windows)
- [dressing.nvim](https://github.com/stevearc/dressing.nvim) it will make the inputs and selects pretty (optional)
## Installation
- [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"lalitmee/browse.nvim",
dependencies = { "nvim-telescope/telescope.nvim" },
}
```
- [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use({
"lalitmee/browse.nvim",
requires = { "nvim-telescope/telescope.nvim" },
})
```
- [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'nvim-telescope/telescope.nvim'
Plug 'lalitmee/browse.nvim'
```
## Setup
```lua
-- default values for the setup
require('browse').setup({
-- search provider you want to use
provider = "google", -- duckduckgo, bing
-- either pass it here or just pass the table to the functions
-- see below for more
bookmarks = {},
icons = {
bookmark_alias = "->", -- if you have nerd fonts, you can set this to ""
bookmarks_prompt = "", -- if you have nerd fonts, you can set this to " "
grouped_bookmarks = "->", -- if you have nerd fonts, you can set this to
}
-- if you want to persist the query for grouped bookmarks
-- See https://github.com/lalitmee/browse.nvim/pull/23
persist_grouped_bookmarks_query = false,
})
```
## Usage
There are so many ways in which you can use this to improve your search experience. After `bookmarks` table support for multiple formats and organized structure of the bookmarks, you can just use `open_bookmarks()` api.
### bookmarks
For bookmarks you can declare your bookmarks in lua table format. `bookmarks`
table can contain multiple structures.
1. grouped urls with a name key in the table (recommended)
```lua
local bookmarks = {
["github"] = {
["name"] = "search github from neovim",
["code_search"] = "https://github.com/search?q=%s&type=code",
["repo_search"] = "https://github.com/search?q=%s&type=repositories",
["issues_search"] = "https://github.com/search?q=%s&type=issues",
["pulls_search"] = "https://github.com/search?q=%s&type=pullrequests",
},
}
```
2. urls with aliases
```lua
local bookmarks = {
["github_code_search"] = "https://github.com/search?q=%s&type=code",
["github_repo_search"] = "https://github.com/search?q=%s&type=repositories",
}
```
3. urls with a query parameter
```lua
local bookmarks = {
"https://github.com/search?q=%s&type=code",
"https://github.com/search?q=%s&type=repositories",
}
```
4. simple and direct urls
```lua
local bookmarks = {
"https://github.com/hoob3rt/lualine.nvim",
"https://github.com/neovim/neovim",
"https://neovim.discourse.group/",
"https://github.com/nvim-telescope/telescope.nvim",
"https://github.com/rockerBOO/awesome-neovim",
}
```
5. you can also combine all of the above in a table if you want.
and then pass this table into the `browse()` function like this
```lua
vim.keymap.set("n", "b", function()
require("browse").browse({ bookmarks = bookmarks })
end)
```
> If this `bookmarks` table will be empty or will not be passed and if you select `Bookmarks`
> from `telescope` result, you will not see anything in the telescope results.
### search
- `input_search()`, it will prompt you to search for something
```lua
require('browse').input_search()
```
- `open_bookmarks()`, search with the table `bookmarks`
```lua
require("browse").open_bookmarks({ bookmarks = bookmarks })
```
- `browse()`, it opens `telescope.nvim` dropdown theme to select the method
```lua
require("browse").browse({ bookmarks = bookmarks })
```
### devdocs
- `devdocs.search()`, search for anything in the [devdocs](https://devdocs.io/)
```lua
require('browse.devdocs').search()
```
- `devdocs.search_with_filetype()`, search for anything for the current file type
```lua
require('browse.devdocs').search_with_filetype()
```
### mdn
- `mdn.search()`, search for anything on [MDN](https://developer.mozilla.org/en-US/)
```lua
require('browse.mdn').search()
```
## Customizations
You can customize the `input_search()` to use the `provider` you like. Possible values for the provider are following:
- `google`
- `duckduckgo`
- `brave`
- `bing`
## Advanced usage
Create commands for all the functions which `browse.nvim` exposes and then simply run whatever you want from the
command line
```lua
local browse = require('browse')
function command(name, rhs, opts)
opts = opts or {}
vim.api.nvim_create_user_command(name, rhs, opts)
end
command("InputSearch", function()
browse.input_search()
end, {})
-- this will open telescope using dropdown theme with all the available options
-- in which `browse.nvim` can be used
command("Browse", function()
browse.browse({ bookmarks = bookmarks })
end)
command("Bookmarks", function()
browse.open_bookmarks({ bookmarks = bookmarks })
end)
command("DevdocsSearch", function()
browse.devdocs.search()
end)
command("DevdocsFiletypeSearch", function()
browse.devdocs.search_with_filetype()
end)
command("MdnSearch", function()
browse.mdn.search()
end)
```
## Acknowledgements and Credits
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
- [open-browser.nvim](https://github.com/tyru/open-browser.vim)
## Support
