https://github.com/superDross/picobook
A little notebook for vim
https://github.com/superDross/picobook
notebook notes plugin vim vim-plugin
Last synced: 11 months ago
JSON representation
A little notebook for vim
- Host: GitHub
- URL: https://github.com/superDross/picobook
- Owner: superDross
- License: gpl-3.0
- Created: 2020-05-24T19:48:04.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-24T23:25:21.000Z (over 1 year ago)
- Last Synced: 2024-11-24T23:28:12.754Z (over 1 year ago)
- Topics: notebook, notes, plugin, vim, vim-plugin
- Language: Vim Script
- Size: 47.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# picoBook
A very tiny & simple notebook for vim.
Heavily inspired by [vimwiki](https://github.com/vimwiki/vimwiki).
Compatible with Vim8.1+
## Key Bindings
Normal Mode:
- `ww` -- Open index page
- `wo` -- Open index page in your browser (browser specified with `g:browser`)
- `wf` -- Open wiki link
- `wt` -- Open wiki link in new tab
- `wv` -- Open wiki link in new vsplit
- `wx` -- Open wiki link in new hsplit
- `wi` -- Open wiki link in GitHub
- `wb` -- Open wiki link in browser
- `wd` -- Delete wiki link and associated file
- `wm` -- Move wiki link and associated file
- `wg` -- FZF grep notes (requires [FZF](https://github.com/junegunn/fzf.vim))
- `wp` -- Create new wiki link and go to the file
- `ws` -- Create new wiki link and go to the script
Commands:
- `:GoToIndex` -- Open index page
- `:GoToNoteWebPage` -- Open wiki link in GitHub
- `:GrepPicoNotes *` -- Vimgrep given args
- `:GrepPicoNotesFzf` -- FZF grep notes
## Setup
### Install:
```vimscript
Plug 'superdross/picobook'
```
### Settings
Set the directory to hold all the notes.
```vimscript
let g:notesdir = '/som/dir/path/'
" path to open weblinks
let g:noteurl = 'https://github.com/superDross/dotfiles/blob/master/notes/'
```
## Example Usage
Set notes location and go to the wiki page:
```vimscript
:let g:notesdir = '/home/me/notes/'
:GoToIndex
```
Create a basic Markdown index file:
```md
# Index
- [Languages](languages.md)
## Data Structures
- [Linked Lists](data_structures/linkedlist.md)
- [Graph Data](data_structures/graphdata.md)
## Python
- [Async](python/async_module.py)
- [Cython](python/cython_tutorial.pyx)
```
Place the cursor at the `Linked Lists` line and press `wf`, the file `/home/me/notes/data_structrues/linkedlist.md` will be opened in the current window.