Top Related Projects
Markdown Vim Mode
markdown preview plugin for (neo)vim
:sunflower: A Vim alignment plugin
Text outlining and task management for Vim based on Emacs' Org-Mode
VimTeX: A modern Vim and neovim filetype plugin for LaTeX files.
Vim script for text filtering and alignment
Quick Overview
Vimwiki is a personal wiki plugin for Vim. It allows users to organize notes, maintain to-do lists, and create documentation using Vim's powerful text editing capabilities. Vimwiki supports multiple wikis, custom syntax highlighting, and various export options.
Pros
- Seamless integration with Vim, leveraging existing Vim skills
- Supports multiple wikis and various markup languages (Markdown, MediaWiki)
- Offers powerful linking and navigation features within and between wiki pages
- Provides export functionality to HTML for easy sharing and publishing
Cons
- Steep learning curve for users not familiar with Vim
- Limited collaborative features compared to web-based wiki solutions
- May require additional plugins or configuration for optimal use
- Can be overwhelming for users who need a simple note-taking solution
Getting Started
- Install Vimwiki using your preferred Vim plugin manager. For example, using vim-plug:
" Add to your .vimrc or init.vim
call plug#begin()
Plug 'vimwiki/vimwiki'
call plug#end()
- Create a basic Vimwiki configuration in your .vimrc or init.vim:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]
-
Open Vim and start using Vimwiki:
- Press
<Leader>wwto open your main wiki index - Use
<Enter>to create or follow links - Press
<Leader>w<Leader>wto create a diary entry for today
- Press
-
Explore Vimwiki's features:
- Create to-do lists with
[ ]for unchecked and[X]for checked items - Use
=signs to create headers (e.g.,= Header 1 =,== Header 2 ==) - Generate table of contents with
:VimwikiTOC - Export to HTML with
:VimwikiAll2HTML
- Create to-do lists with
For more detailed instructions and advanced features, refer to the official Vimwiki documentation using :help vimwiki within Vim.
Competitor Comparisons
Markdown Vim Mode
Pros of vim-markdown
- Focused specifically on Markdown syntax highlighting and features
- Lightweight and faster performance for Markdown-only use cases
- Better integration with external Markdown tools and processors
Cons of vim-markdown
- Limited to Markdown files, lacks wiki-like interlinking capabilities
- No built-in task management or todo list features
- Less comprehensive note-taking and personal knowledge management functionality
Code comparison
vim-markdown:
let g:vim_markdown_folding_disabled = 1
let g:vim_markdown_frontmatter = 1
let g:vim_markdown_conceal = 0
vimwiki:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]
let g:vimwiki_global_ext = 0
Summary
vim-markdown is a specialized plugin for Markdown editing in Vim, offering better performance and integration with Markdown tools. However, it lacks the comprehensive wiki and note-taking features of vimwiki. vimwiki provides a more robust personal knowledge management system with interlinking and task management capabilities, but may be overkill for simple Markdown editing. The choice between the two depends on whether you need a full-featured wiki system or a lightweight Markdown editor.
markdown preview plugin for (neo)vim
Pros of markdown-preview.nvim
- Real-time preview of Markdown files in a web browser
- Supports various Markdown extensions and custom CSS
- Lightweight and fast, with minimal setup required
Cons of markdown-preview.nvim
- Limited to Markdown files only, unlike Vimwiki's support for multiple formats
- Lacks built-in wiki-like features such as interlinking and task management
- Requires an external browser for preview, while Vimwiki operates entirely within Vim
Code Comparison
markdown-preview.nvim:
" Basic setup
Plug 'iamcco/markdown-preview.nvim', { 'do': 'cd app && yarn install' }
nmap <C-p> <Plug>MarkdownPreviewToggle
Vimwiki:
" Basic setup
Plug 'vimwiki/vimwiki'
let g:vimwiki_list = [{'path': '~/vimwiki/', 'syntax': 'markdown', 'ext': '.md'}]
markdown-preview.nvim focuses on providing a seamless Markdown preview experience, while Vimwiki offers a more comprehensive personal wiki solution within Vim. The choice between the two depends on whether you need a dedicated Markdown preview tool or a full-featured wiki system for note-taking and organization.
:sunflower: A Vim alignment plugin
Pros of vim-easy-align
- Focused functionality for aligning text, making it more lightweight
- Intuitive and flexible alignment commands
- Supports various alignment patterns and delimiters
Cons of vim-easy-align
- Limited to text alignment, lacking broader note-taking features
- Requires manual invocation for each alignment operation
- May not be as useful for general-purpose writing tasks
Code comparison
vim-easy-align:
" Align GitHub-flavored Markdown tables
vmap <Enter> <Plug>(EasyAlign)
nmap ga <Plug>(EasyAlign)
vimwiki:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]
Summary
vim-easy-align is a specialized Vim plugin for aligning text, offering precise control over text formatting. It's lightweight and efficient for its specific purpose but lacks the comprehensive note-taking and wiki-style features of vimwiki.
vimwiki, on the other hand, provides a complete personal wiki system within Vim, supporting various markup languages and offering extensive note-taking capabilities. While it may not have the advanced alignment features of vim-easy-align, it offers a more comprehensive solution for managing personal knowledge and documentation.
The choice between these plugins depends on the user's specific needs: vim-easy-align for focused text alignment or vimwiki for a full-featured personal wiki system.
Text outlining and task management for Vim based on Emacs' Org-Mode
Pros of vim-orgmode
- Closer integration with Emacs Org-mode syntax and features
- Better support for complex task management and scheduling
- More robust agenda view and date/time handling
Cons of vim-orgmode
- Steeper learning curve due to Org-mode complexity
- Less intuitive for users not familiar with Org-mode
- Potentially slower performance for large files
Code Comparison
vim-orgmode:
:OrgAgendaWeek
:OrgCheckboxUpdate
:OrgDateDemote
vimwiki:
:VimwikiIndex
:VimwikiFollowLink
:VimwikiTable
Key Differences
- Syntax: vim-orgmode uses Org-mode syntax, while vimwiki has its own simplified markup
- Focus: vim-orgmode emphasizes task management, while vimwiki is more general-purpose
- Compatibility: vim-orgmode aims for Org-mode compatibility, vimwiki is self-contained
Use Cases
- vim-orgmode: Ideal for users transitioning from Emacs Org-mode or needing advanced task management
- vimwiki: Better for users wanting a simple, fast wiki system with basic task lists
Community and Development
- vim-orgmode: Smaller community, less frequent updates
- vimwiki: Larger user base, more active development and plugin ecosystem
VimTeX: A modern Vim and neovim filetype plugin for LaTeX files.
Pros of VimTeX
- Specialized for LaTeX document preparation, offering deep integration with LaTeX workflows
- Extensive compilation, viewing, and error handling features for LaTeX documents
- Robust syntax highlighting and completion for LaTeX commands and environments
Cons of VimTeX
- Limited to LaTeX-specific functionality, lacking general note-taking capabilities
- Steeper learning curve for users not familiar with LaTeX
Code Comparison
VimTeX:
let g:vimtex_compiler_latexmk = {
\ 'options' : [
\ '-pdf',
\ '-shell-escape',
\ '-verbose',
\ '-file-line-error',
\ '-synctex=1',
\ '-interaction=nonstopmode',
\ ],
\}
Vimwiki:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]
let g:vimwiki_global_ext = 0
let g:vimwiki_folding = 'syntax'
VimTeX focuses on LaTeX-specific configuration, while Vimwiki offers more general wiki and note-taking setup options. VimTeX provides detailed compiler settings, whereas Vimwiki configures wiki locations and syntax preferences.
Vim script for text filtering and alignment
Pros of Tabular
- Focused on aligning text and creating tables, offering precise control over formatting
- Lightweight and easy to integrate into existing Vim workflows
- Supports custom alignment patterns for complex formatting needs
Cons of Tabular
- Limited to text alignment and table creation functionality
- Requires manual input for each table or alignment operation
- Lacks built-in note-taking or wiki-style organization features
Code Comparison
Tabular:
:Tabularize /,/
:Tabularize /=\zs/l1r1
Vimwiki:
= My Header =
* List item 1
* List item 2
[[Link to another page]]
Summary
Tabular is a specialized Vim plugin for text alignment and table creation, offering precise control over formatting. It's lightweight and easy to integrate but lacks the comprehensive note-taking and wiki-style organization features of Vimwiki. Tabular is ideal for users who need powerful alignment tools within their existing Vim setup, while Vimwiki provides a more complete solution for personal knowledge management and note-taking directly within Vim.
Convert 
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
- Intro
- Screenshots
- Installation
- Basic Markup
- Key Bindings
- Commands
- Changing Wiki Syntax
- Getting Help
- Helping VimWiki
- Wiki
- License
Introduction
VimWiki is a personal wiki for Vim -- a number of linked text files that have their own syntax highlighting. See the VimWiki Wiki for an example website built with VimWiki!
If you are interested in contributing see this section.
With VimWiki, you can:
- Organize notes and ideas
- Manage to-do lists
- Write documentation
- Maintain a diary
- Export everything to HTML
To do a quick start, press <Leader>ww (default is \ww) to go to your index
wiki file. By default, it is located in ~/vimwiki/index.wiki. See
:h vimwiki_list for registering a different path/wiki.
Feed it with the following example:
= My knowledge base =
* Tasks -- things to be done _yesterday_!!!
* Project Gutenberg -- good books are power.
* Scratchpad -- various temporary stuff.
Place your cursor on Tasks and press Enter to create a link. Once pressed,
Tasks will become [[Tasks]] -- a VimWiki link. Press Enter again to
open it. Edit the file, save it, and then press Backspace to jump back to your
index.
A VimWiki link can be constructed from more than one word. Just visually
select the words to be linked and press Enter. Try it, with Project Gutenberg.
The result should look something like:
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
Screenshots
Installation
VimWiki has been tested on Vim >= 7.3. It may work on older versions but will not be officially supported. It is known to work on NeoVim, although it is likely to have NeoVim-specific bugs.
Prerequisites
Make sure you have these settings in your vimrc file:
set nocompatible
filetype plugin on
syntax on
Without them, VimWiki will not work properly.
Installation using Vim packages (since Vim 7.4.1528)
git clone https://github.com/vimwiki/vimwiki.git ~/.vim/pack/plugins/start/vimwiki
# to generate documentation i.e. ':h vimwiki'
vim -c 'helptags ~/.vim/pack/plugins/start/vimwiki/doc' -c quit
Notes:
- See
:h helptagsfor issues with installing the documentation. - For general information on vim packages see
:h packages.
Installation using Pathogen
cd ~/.vim
mkdir bundle
cd bundle
git clone https://github.com/vimwiki/vimwiki.git
Installation using Vim-Plug
Add the following to the plugin-configuration in your vimrc:
Plug 'vimwiki/vimwiki'
Then run :PlugInstall.
Installation using Vundle
Add Plugin 'vimwiki/vimwiki' to your vimrc file and run:
vim +PluginInstall +qall
Manual Install
Download the zip archive
and extract it in ~/.vim/bundle/
Then launch Vim, run :Helptags and then :help vimwiki to verify it was
installed.
Basic Markup
= Header1 =
== Header2 ==
=== Header3 ===
*bold* -- bold text
_italic_ -- italic text
[[wiki link]] -- wiki link
[[wiki link|description]] -- wiki link with description
Lists
* bullet list item 1
- bullet list item 2
- bullet list item 3
* bullet list item 4
* bullet list item 5
* bullet list item 6
* bullet list item 7
- bullet list item 8
- bullet list item 9
1. numbered list item 1
2. numbered list item 2
a) numbered list item 3
b) numbered list item 4
For other syntax elements, see :h vimwiki-syntax
Todo lists
- [.] Partially completed item with sub-tasks
- [X] Completed sub-task
- [ ] Incomplete sub-task
- [ ] Other incomplete sub-task
- [ ] Incomplete item
Key bindings
Normal mode
Note: your terminal may prevent capturing some of the default bindings
listed below. See :h vimwiki-local-mappings for suggestions for alternative
bindings if you encounter a problem.
Basic key bindings
<Leader>ww-- Open default wiki index file.<Leader>wt-- Open default wiki index file in a new tab.<Leader>ws-- Select and open wiki index file.<Leader>wd-- Delete wiki file you are in.<Leader>wr-- Rename wiki file you are in.<Enter>-- Follow/Create wiki link.<Shift-Enter>-- Split and follow/create wiki link.<Ctrl-Enter>-- Vertical split and follow/create wiki link.<Backspace>-- Go back to parent(previous) wiki link.<Tab>-- Find next wiki link.<Shift-Tab>-- Find previous wiki link.
Advanced key bindings
Refer to the complete documentation at :h vimwiki-mappings to see many
more bindings.
Commands
:Vimwiki2HTML-- Convert current wiki link to HTML.:VimwikiAll2HTML-- Convert all your wiki links to HTML.:help vimwiki-commands-- List all commands.:help vimwiki-- General vimwiki help docs.
Changing Wiki Syntax
VimWiki currently ships with 3 syntaxes: VimWiki (default), Markdown (markdown), and MediaWiki (media). Of these, the native VimWiki syntax is best supported, followed by Markdown. No promises are made for MediaWiki.
NOTE: Only the default syntax ships with a built-in HTML converter. For
Markdown or MediaWiki see :h vimwiki-option-custom_wiki2html. Some examples
and 3rd party tools are available
here.
If you would prefer to use either Markdown or MediaWiki syntaxes, set the
following option in your .vimrc:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': 'md'}]
This option will treat all markdown files in your system as part of vimwiki
(check set filetype?). Add
let g:vimwiki_global_ext = 0
to your .vimrc to restrict Vimwiki's operation to only those paths listed in
g:vimwiki_list. Other markdown files wouldn't be treated as wiki pages.
See g:vimwiki_global_ext.
if you want to turn off support for other extension(for example, disabling
accidently creating new wiki and link for normal markdown files), set the
following option in your .vimrc before packadd vimwiki:
let g:vimwiki_ext2syntax = {}
Getting help
GitHub issues are the primary method for raising bug reports or feature requests.
Additional resources:
- The IRC channel #vimwiki on irc.libera.chat is the "official" discussion and support channel
- @vimwiki@wikis.world on the Fediverse
Helping VimWiki
VimWiki has a lot of users but only very few recurring developers or people helping the community. Your help is therefore appreciated. Everyone can help! See #625 for information on how you can help.
Also, take a look at CONTRIBUTING.md and design_notes.md
License
MIT License
Copyright (c) 2008-2010 Maxim Kim 2013-2017 Daniel Schemala
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Top Related Projects
Markdown Vim Mode
markdown preview plugin for (neo)vim
:sunflower: A Vim alignment plugin
Text outlining and task management for Vim based on Emacs' Org-Mode
VimTeX: A modern Vim and neovim filetype plugin for LaTeX files.
Vim script for text filtering and alignment
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot