commit 7c892e2516fe49f1ac62d9eedff89f800252b868
parent b6ea14d3f89ab342b04f543bc6b183480c7e34bb
Author: Rane Brown <rane.brown@gmail.com>
Date: Fri, 20 Dec 2019 20:40:55 -0700
Add link to Vimwikiwiki and more info on contributing.
Adds note that only the default syntax has a built in HTML converter.
Also incorporates a few stylistic changes.
Diffstat:
| M | README.md | | | 91 | ++++++++++++++++++++++++++++++++++++++++++------------------------------------- |
1 file changed, 48 insertions(+), 43 deletions(-)
diff --git a/README.md b/README.md
@@ -22,32 +22,34 @@
----
-## Intro
+## Introduction
VimWiki is a personal wiki for Vim -- a number of linked text files that have
-their own syntax highlighting.
+their own syntax highlighting. See the [VimWiki Wiki](https://vimwiki.github.io/vimwikiwiki/)
+for an example website built with VimWiki!
+
+For the latest features and fixes checkout the [dev branch](https://github.com/vimwiki/vimwiki/tree/dev).
+If you are interested in contributing see [this section](#helping-vimwiki).
With VimWiki, you can:
- * Organize notes and ideas
- * Manage to-do lists
- * Write documentation
- * Maintain a diary
- * Export everything to HTML
+- 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` (this is usually `\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.
+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:
-```
-
+```text
= 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,
@@ -59,13 +61,11 @@ 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:
-```
-
+```text
= My knowledge base =
* [[Tasks]] -- things to be done _yesterday_!!!
* [[Project Gutenberg]] -- good books are power.
* Scratchpad -- various temporary stuff.
-
```
## Screenshots
@@ -75,7 +75,6 @@ The result should look something like:
-
## Installation
### Prerequisites
@@ -83,16 +82,13 @@ The result should look something like:
Make sure you have these settings in your vimrc file:
```vim
-
set nocompatible
filetype plugin on
syntax on
-
```
Without them, VimWiki will not work properly.
-
#### Installation using [Vim packages](http://vimhelp.appspot.com/repeat.txt.html#packages) (since Vim 7.4.1528)
```sh
@@ -143,7 +139,7 @@ installed.
## Basic Markup
-```
+```text
= Header1 =
== Header2 ==
=== Header3 ===
@@ -156,9 +152,9 @@ _italic_ -- italic text
[[wiki link|description]] -- wiki link with description
```
-### Lists:
+### Lists
-```
+```text
* bullet list item 1
- bullet list item 2
- bullet list item 3
@@ -187,17 +183,17 @@ 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.
+- `<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
@@ -206,18 +202,22 @@ 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.
+- `: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).
+**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](https://vimwiki.github.io/vimwikiwiki/Related%20Tools.html#Related%20Tools-External%20Tools).
+
If you would prefer to use either Markdown or MediaWiki syntaxes, set the
-following option in your .vimrc:
+following option in your `.vimrc`:
```vim
@@ -228,15 +228,20 @@ let g:vimwiki_list = [{'path': '~/vimwiki/',
## Getting help
-**Have a question?**
-Visit the IRC channel [`#vimwiki`](https://webchat.freenode.net/?channels=#vimwiki) on Freenode ([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org` and [Telegram](https://t.me/joinchat/JqBaKBfWs04qNVrp5oWcMg)) or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
+[GitHub issues](https://github.com/vimwiki/vimwiki/issues) are the primary
+method for raising bug reports or feature requests.
+
+Additional resources include the IRC channel [#vimwiki](https://webchat.freenode.net/?channels=#vimwiki) on Freenode
+([webchat](https://webchat.freenode.net/?channels=#vimwiki), also synced to Matrix/Riot: `#freenode_#vimwiki:matrix.org` and [Telegram](https://t.me/joinchat/JqBaKBfWs04qNVrp5oWcMg))
+or post to the [mailing list](https://groups.google.com/forum/#!forum/vimwiki).
## 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](https://github.com/vimwiki/vimwiki/issues/625) for information on
-how you can help.
+See [#625](https://github.com/vimwiki/vimwiki/issues/625) for information on how you can help.
+
+Also, take a look at [CONTRIBUTING.md](https://github.com/vimwiki/vimwiki/blob/dev/CONTRIBUTING.md) on the `dev` branch.
----
