https://github.com/rhysd/nyaovim-mini-browser
Embedded Mini Browser for NyaoVim
https://github.com/rhysd/nyaovim-mini-browser
Last synced: over 1 year ago
JSON representation
Embedded Mini Browser for NyaoVim
- Host: GitHub
- URL: https://github.com/rhysd/nyaovim-mini-browser
- Owner: rhysd
- Created: 2015-12-27T18:30:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-25T14:07:16.000Z (over 8 years ago)
- Last Synced: 2025-04-14T10:04:43.573Z (over 1 year ago)
- Language: HTML
- Homepage: https://github.com/rhysd/NyaoVim
- Size: 8.79 KB
- Stars: 33
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Inner Mini Browser for [NyaoVim](https://github.com/rhysd/NyaoVim)
==================================================================
This is [NyaoVim](https://github.com/rhysd/NyaoVim) UI plugin to open an embedded browser in window. This is implemented as Web Component and built on [Electron's webview](https://github.com/atom/electron/blob/master/docs/api/web-view-tag.md).
## Installation
Install this repository as Vim plugin with your favorite plugin manager. And put `` component to your `nyaovimrc.html` as below.
```html
/* CSS configurations here */
.horizontal {
display: flex;
width: 100%;
height: 100%;
}
neovim-editor {
width: 100%;
height: 100%;
}
```
This is a setting example. You can put `` component as you like.
## Commands
- `:MiniBrowser [url]`: Open mini browser with specified URL. If `url` is omitted, previous page is shown. If you add `!` to the command, focus doesn't move after opening a browser.
- `:MiniBrowserClose`: Close mini browser.
## Keymaps In Browser
| keymap | description |
| ------ | ----------- |
| `j` | Scroll half page down |
| `k` | Scroll half page up |
| `h` | Scroll half page left |
| `l` | Scroll half page right |
| `Ctrl+x` | Close mini browser |
| `Ctrl+Shift+f` | Page goes forward |
| `Ctrl+Shift+b` | Page goes back |
| `Ctrl+r` | Reload page |
| `Ctrl+Shift+i` | Open DevTools window |
## Extend Your Usage
This plugin only provides very simple commands. You can write script to extend your usage with the commands as below.
- Open GitHub issues of current repository
- Look for a word under the cursor in online documentations
- Search something on Google Search
- Play music on SoundCloud ;)
- etc...
### Example1: Open URL under cursor
If you want to open a URL under cursor, adding below mapping to `init.vim` will help you. Mapping to `o` is an example. You can map it to your favorite key sequence.
```vim
nnoremap o :MiniBrowser
```
### Example2: [devdocs.io](http://devdocs.io/)
Below is an example configuration to search [devdocs.io](http://devdocs.io) instantly. `:Devdocs` command is defined. When parameter is given, it opens devdocs.io with the parameter as query. If no parameter is given, it opens devdocs.io with the word under cursor.
```vim
function! s:devdocs(query) abort
if a:query ==# ''
let cword = expand('')
if cword ==# ''
MiniBrowser http://devdocs.io/
else
execute 'MiniBrowser' 'http://devdocs.io/#q='.escape(cword, ' \')
endif
return
endif
execute 'MiniBrowser' 'http://devdocs.io/#q='.escape(a:query, ' \')
endfunction
command! -nargs=* DevDocs call devdocs()
```
## Properties of ``
You can specify `url`, `width`, `useragent`, and `visible` to the tag.
```html
```
## License
```
Copyright (c) 2015 rhysd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```