Alexander/mykb
1
0
Fork 0
mirror of https://github.com/AlexBocken/mykb.git synced 2024-11-24 12:12:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added installation instructions

Browse Source
This commit is contained in:
TillDiem 2021-11-27 16:54:52 +01:00
parent 9d3b3f99e6
commit 3fa46aa6da
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/vimwiki.md
View File

@ -54,6 +54,20 @@ Afterwords run `:Helptags` in the command prompt of vim.
Add `Plugin 'vimwiki/vimwiki'` to the `init.vim` or `.vimrc`. Add `Plugin 'vimwiki/vimwiki'` to the `init.vim` or `.vimrc`.
Afterwords run `vim +PluginInstall +qall` in the shell to install it. Afterwords run `vim +PluginInstall +qall` in the shell to install it.
## Install of the mykb - vimwiki
To install the _mykb_ version of vimwiki, clone [https://github.com/AlexBocken/mykb](https://github.com/AlexBocken/mykb) in to the folder of your preference and add
```
let g:vimwiki_list = [{'path': '/PATH/TO/DIRECTORY/mykb', 'syntax': 'markdown', 'ext': '.md'}]
```
to your `.vimrc`.
To make the usage more userfriendly, add
```
alias mykb='nvim /PATH/mykb.md`
```
to your aliases. To then open it, just run `mykb`.
### Configuration ### Configuration
To go to the index page you enter `<leader>ww`. To go to the index page you enter `<leader>ww`.