Simple extension for vimwiki enabling weekly, monthly and yearly reviews. Check out VimL version for Vim support.
- NeoVim version 0.5.0+
- vimwiki plugin
- plenary.nvim plugin
Install using favourite plugin manager. This plugin depends on plenary.nvim.
- Using Packer.nvim
use {
'https://codeberg.org/vimwiki-reviews/vimwiki-reviews-lua.git',
requires = { 'vimwiki/vimwiki', 'nvim-lua/plenary.nvim' }
}
or if vimwiki and plenary are already listed:
use 'https://codeberg.org/vimwiki-reviews/vimwiki-reviews-lua.git'
Then install via :PackerInstall or :PackerSync
- Using Plug
Plug 'vimwiki/vimwiki'
Plug 'nvim-lua/plenary.nvim'
Plug 'https://codeberg.org/vimwiki-reviews/vimwiki-reviews-lua.git'
Then install via :PlugInstall
Plugin is meant to integrate well with usual vimwiki commands and keymaps.
By default, plugin stored reviews in reviews subdirectory inside vimwiki
directory. It generates index named reviews.ext in that directory.
:VimwikiWeeklyReview, :VimwikiNextWeeklyReview and :VimwikiPrevWeeklyReview open up weekly review for current vimwiki (count may be passed as first argumeny to select vimwiki).
:VimwikiWeeklyTemplate opens up template file for weekly reviews for current vimwiki (count may be passed as first argumeny to select vimwiki). If no template file exists, it is created. If no file exists at time of creation of reviews, default template is used.
:VimwikiMonthlyReview, :VimwikiNextMonthlyReview and :VimwikiPrevMonthlyReview open up monthly review for current vimwiki (count may be passed as first argumeny to select vimwiki).
:VimwikiMonthlyTemplate opens up template file for monthly reviews for current vimwiki (count may be passed as first argumeny to select vimwiki). If no template file exists, it is created. If no file exists at time of creation of reviews, default template is used.
:VimwikiYearlyReview, :VimwikiNextYearlyReview and :VimwikiPrevYearlyReview open up yearly review for current vimwiki (count may be passed as first argumeny to select vimwiki).
:VimwikiYearlyTemplate opens up template file for yearly reviews for current vimwiki (count may be passed as first argumeny to select vimwiki). If no template file exists, it is created. If no file exists at time of creation of reviews, default template is used.
:VimwikiReviewIndex opens reviews index file and automatically generates content for current vimwiki (count may be passed as first argumeny to select vimwiki).
Plugin creates keymaps by default which can be disabled by setting g:vimwiki_reviews_disable_maps option to 1.
By default, these are very similar to default maps for vimwiki:
<Leader>wrwwinvokes:VimwikiWeeklyReview<Leader>wrwpinvokes:VimwikiPrevWeeklyReview<Leader>wrwninvokes:VimwikiNextWeeklyReview<Leader>wrtwinvokes:VimwikiWeeklyTemplate<Leader>wrmminvokes:VimwikiMonthlyReview<Leader>wrmpinvokes:VimwikiPrevMonthlyReview<Leader>wrmninvokes:VimwikiNextMonthlyReview<Leader>wrtminvokes:VimwikiMonthlyTemplate<Leader>wryyinvokes:VimwikiYearlyReview<Leader>wrypinvokes:VimwikiPrevYearlyReview<Leader>wryninvokes:VimwikiNextYearlyReview<Leader>wrtyinvokes:VimwikiYearlyTemplate<Leader>wriinvokes:VimwikiReviewIndex
All of the maps are mapped to corresponding <Plug> mappings, which are named the same as commands used. For example:
<Leader>wrww maps to <Plug>VimwikiWeeklyReview which invokes :VimwikiWeeklyReview
Template filles will just be copied over to newly created reviews. Currently templates support %date% template which will be replaced with date of review.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent