lervag/wiki.vim
lervag/wiki.vim has 782 GitHub stars and 67 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-15 15:21 UTC. Last push 2026-11-13.
What you can do
- WikiIndex to open the index
- WikiJournal to open the journal
- WikiPages to select from list of all pages
- WikiTags to select from list of tags
측정된 스타 증가
- in 24h
- 0
- in 7 days
- 업데이트 지연
- in 15 days
- 업데이트 지연
- in 1 month
- 업데이트 지연
서로 겹치는 기간의 순증가량이며 일별 합계가 아닙니다. 측정값이 없으면 비워 둡니다. 스타는 관심도를 나타내며 품질을 보장하지 않습니다.
소개
A wiki plugin for Vim
개발 도구README.md
Originalwiki.vim
This is a Vim and neovim plugin for writing and maintaining a personal wiki. The plugin was initially based on vimwiki, but it is written mostly from scratch and is based on a more "do one thing and do it well" philosophy.
This README file contains basic information on how to get started, as well as
a list of available features. For more details, please read the
full documentation (:help wiki.vim if the plugin
is installed).
[!NOTE]
wiki.vimis not a filetype plugin. It is designed to be used with filetype plugins, e.g. dedicated Markdown plugins. Users are advised to read:help wiki-intro-pluginsfor a list of plugins that work well withwiki.vim.
[!WARNING]
wiki.vimrequires Vim 9.1 or Neovim 0.10!
Table of contents
Quick Start
Installation
There are a lot of methods for installing plugins. The following explains the most common and popular approaches.
lazy.nvim
To install wiki.vim, add a plugin spec similar to this:
{
"lervag/wiki.vim",
-- tag = "v0.10", -- uncomment to pin to a specific release
init = function()
-- wiki.vim configuration goes here, e.g.
end
}
wiki.vim is mostly implemented in Vimscript and is configured with the
classical vimscript variable convention like g:wiki_OPTION_NAME. Nowadays,
Neovim is often configured with Lua, thus some users may be interested in
reading :help lua-vimscript.
vim-plug
If you use vim-plug, then add one of
the following lines to your configuration. The first will use the latest
versions from the master branch, whereas the second will pin to a release
tag.
Plug 'lervag/wiki.vim'
Plug 'lervag/wiki.vim', { 'tag': 'v0.10' }
Other
There are many other plugin managers out there. They are typically well documented, and it should be straightforward to extrapolate the above snippets.
Usage
This outlines the basic steps to get started:
Create a wiki directory where the wiki files should be stored, for instance
~/wiki.Add the following to your
vimrcfile:let g:wiki_root = '~/wiki'Now you can open the index file with
<leader>wwand start to add your notes as desired.
Please also read the Guide section in the documentation.
Features
- Wiki functionality
- Global
- Commands (and mappings) to access a pre-specified wiki (
g:wiki_root)WikiIndexto open the indexWikiJournalto open the journalWikiPagesto select from list of all pagesWikiTagsto select from list of tags
- Commands (and mappings) to access a pre-specified wiki (
- Local commands and mappings for
- Navigation (follow links, go back, etc)
- Renaming pages (will also update links in other pages)
- Navigate through a table of contents (
WikiToc) - Creating a table of contents (
WikiTocGenerate) - Transforming links (from text to link or between link types)
- Viewing wiki link graphs
- Displaying incoming links (see
WikiLinkIncomingToggle)
- Completion of wiki links and link anchors
- Text objects
iu auLink URLit atLink text
- New page templates
- Global
- Support for journal entries
- Navigating the journal back and forth with
<c-p>and<c-n> - Support for parsing journal entries in order to make weekly and monthly summaries. The parsed result needs manual editing for good results.
- Navigating the journal back and forth with
- Utility functionality
:WikiExportcommand for exporting to e.g.pdfwithpandoc
- Third-party support
- ncm2: SubscopeDetector for nested completion
Acknowledgements
Without vimwiki, this plugin would never
have existed. So my thanks go to the smart people that developed and maintains
vimwiki, both for the inspiration and for the ideas.
Alternatives
Feel free to consider any of the many available alternatives. There are likely many more, but these are the ones I'm aware of: