GitHub - lervag/wiki.vim: A wiki plugin for Vim
source link: https://github.com/lervag/wiki.vim
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Introduction
This is a Vim plugin for writing and maintaining a personal wiki in Markdown syntax. It is based on vimwiki, but written mostly from scratch.
This README file contains basic information on how to get started, as well as a list of available features. For complete documentation, please confer the full documentation.
Table of contents
Quick Start
Installation
If you use vim-plug, then add the
following line to your vimrc
file:
Plug 'lervag/wiki.vim'
Or use some other plugin manager:
Usage
This outlines the basic steps necessary to get started:
-
Create a wiki directory where the wiki files should be stored, for instance
~/documents/wiki
. -
Add the following to your
vimrc
file:let g:wiki_root = '~/documents/wiki'
-
Now you can open the index file (that is,
index.wiki
) with<leader>ww
and start to add your notes as desired.
For more details, see the full documentation.
Features
- Syntax highlighting for
.wiki
files (only within the personal wiki) - Completion of wiki links and link anchors
- Mappings
- Global mappings for accessing the wiki
- Local mappings for
- Navigation (follow links, go back, etc)
- Renaming pages (will also update links in other pages)
- Creating a table of contents
- Toggling links
- Toggling lists (marking as done/undone or add/remove TODO)
- Running code snippets (Note: This needs work)
- Viewing wiki link graphs
- Support for journal entries
- Navigating the journal back and forth with
<c-j>
and<c-k>
- 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
- Text objects
iu au
Link urlit at
Link textic ac
Code blocksil al
List items
- Folds
- Third-party support
TODO
This plugin was initially a personal project that I never really intended to share. After having used it for quite some time, I have realized that it might be useful to more people. However, there is a lot of work to be done to make this plugin more community friendly.
This is a list of TODO items that anyone may follow up on. I am very willing to accept contributions, both as issues describing problems or as pull requests for implementing bug fixes or missing features.
- Features
Related projects
Acknowledgements
Without vimwiki, thus 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.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK