Simple periodical review extension for vimwiki(https://github.com/vimwiki/vimwiki).
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Ensar Sarajcic f8d13f32e1 Move CI to Codeberg 5 months ago
.woodpecker Move CI to Codeberg 5 months ago
doc Update installation instructions to use codeberg.org 5 months ago
lua Format code with stylua 7 months ago
plugin Fix previous monthly review plug map 2 years ago
scripts Add pre-commit hooks and devsetup 7 months ago
.editorconfig Add editorconfig 7 months ago
.gitignore Initial commit 2 years ago
.luacheckrc Fix formatting and lint issues 2 years ago
LICENSE Initial commit 2 years ago
README.md Update installation instructions to use codeberg.org 5 months ago

README.md

Vimwiki reviews

Simple extension for vimwiki enabling weekly, monthly and yearly reviews. Check out VimL version for Vim support.

Requirements

Installation

Install using favourite plugin manager. This plugin depends on plenary.nvim.

  1. 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

  1. Using Plug
Plug 'vimwiki/vimwiki'
Plug 'nvim-lua/plenary.nvim'
Plug 'https://codeberg.org/vimwiki-reviews/vimwiki-reviews-lua.git'

Then install via :PlugInstall

Usage

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.

Commands

Weekly reviews

: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.

Monthly reviews

: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.

Yearly reviews

: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.

Reviews index

:VimwikiReviewIndex opens reviews index file and automatically generates content for current vimwiki (count may be passed as first argumeny to select vimwiki).

Keymaps

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>wrww invokes :VimwikiWeeklyReview
  • <Leader>wrwp invokes :VimwikiPrevWeeklyReview
  • <Leader>wrwn invokes :VimwikiNextWeeklyReview
  • <Leader>wrtw invokes :VimwikiWeeklyTemplate
  • <Leader>wrmm invokes :VimwikiMonthlyReview
  • <Leader>wrmp invokes :VimwikiPrevMonthlyReview
  • <Leader>wrmn invokes :VimwikiNextMonthlyReview
  • <Leader>wrtm invokes :VimwikiMonthlyTemplate
  • <Leader>wryy invokes :VimwikiYearlyReview
  • <Leader>wryp invokes :VimwikiPrevYearlyReview
  • <Leader>wryn invokes :VimwikiNextYearlyReview
  • <Leader>wrty invokes :VimwikiYearlyTemplate
  • <Leader>wri invokes :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

Templates

Template filles will just be copied over to newly created reviews. Currently templates support %date% template which will be replaced with date of review.

License

MIT