gemivim

VIM plugin for Gemini browsing
Log (Feed) | Files | Refs (Tags) | README | LICENSE

README.md (2037B)

      1 # Gemivim - Gemini browser in VIM
      2 
      3 This is a simple VIM plugin for browsing [Gemini](https://gemini.circumlunar.space) pages
      4 
      5 It uses [gmni](https://sr.ht/~sircmpwn/gmni/) as a gemini client and supports:
      6 
      7 - Get gemini content by given URL
      8 - Netrw gx-like open gemini link under cursor 
      9 - Capturing input when gemini resource anticipates to
     10 - Bookmarks management
     11 
     12 Since plugin does nothing but storing content in temporary files and opening them in buffers, one could find quite convenient
     13 to use whole power of VIM with search, jumplists, tabs, whatever to browse efficiently.
     14 
     15 [![asciicast](https://asciinema.org/a/rbdVrL4TJfCT8uSifV6xYoERS.svg)](https://asciinema.org/a/rbdVrL4TJfCT8uSifV6xYoERS)
     16 
     17 ## Dependencies:
     18 
     19 - [gmni](https://git.sr.ht/~sircmpwn/gmni/)
     20 - You may find useful [gemini.vim](https://git.sr.ht/~torresjrjr/gemini.vim/) or [gemini-vim-syntax](https://tildegit.org/sloum/gemini-vim-syntax/) projects, but it's not necessary for Gemivim
     21 
     22 ## Installation:
     23 
     24 With plugin managers:
     25 
     26 ### Vim-Plug:
     27 
     28 ```
     29 Plug 'https://git.sr.ht/~k1nkreet/gemivim'
     30 ```
     31 
     32 ### Vundle:
     33 
     34 ```
     35 Bundle 'https://git.sr.ht/~k1nkreet/gemivim'
     36 ```
     37 
     38 or just copy autoload/gemivim.vim into ~/.vim/autoload and plugin/gemivim.vim into ~/vim/plugin directories.
     39 
     40 ## Usage:
     41 
     42 ### Commands:
     43 
     44 Gemivim provides several commands for processing gemini links and bookmarks, consider map any of them as a shortcut:
     45 
     46 - GemivimOpen - invokes prompt for input gemini url
     47 - GemivimGX - open link under the cursor 
     48 - GemivimOpenBookmarks - open bookmarks file
     49 - GemivimAddBookmark - add current url into bookmarks
     50 - GemivimAddCursorBookmark - add url under cursor into bookmarks
     51 - GemivimRemoveBookmark - remove current url from bookmarks
     52 - GemivimRemoveCursorBookmark - remove url under cursor from bookmarks
     53 - GemivimRefresh - get and reopen link in current buffer
     54 
     55 ### Bookmarks:
     56 
     57 By default it uses gmni's default bookmarks file: ~/.local/share/gmni/bookmarks.gmi, but you can use your own file by:
     58 
     59 ```
     60 let g:gemini_bookmarks_file = /path/to/your/bookmarks/file
     61 ```