vimwiki

commit 28675698ad2e4114d93f3cda86535ea31f175a4d
parent fdc367f7250989e78ccbd6454fade109e008cdaa
Author: Ben <benjamin.mchone@gmail.com>
Date:   Fri, 12 Oct 2018 15:20:26 -0500

Added syntax documentation to README.md

Currently, there is no easy way for a new user of this plugin to discover how to change the syntax. Markdown is favored by many in the community because it is more widely used than Vimwiki's default syntax and is therefore a more portable option. This configuration should be presented much more openly.

Diffstat:
M
README.md
 | 
13
+++++++++++++

1 file changed, 13 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -105,6 +105,19 @@ 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)
+
+ 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'}]
+ ```
 
 
 Installation