params.json

{
  "name": "Vimwiki",
  "tagline": "A personal wiki for Vim",
  "body": "Vimwiki is a personal wiki for Vim – interlinked, plain text files written in a markup language\r\n\r\n# With Vimwiki you can\r\n * organize notes and ideas and quickly create links between them\r\n * manage todo-lists\r\n * write a diary\r\n\r\n## Features\r\n* three markup syntaxes supported: Vimwiki's own syntax, Markdown, MediaWiki\r\n* export everything to HTML\r\n* link to other wiki pages and external files\r\n* search through all wiki pages\r\n* outline notes and tasks in indented lists\r\n* quickly manipulate numbered and bulleted lists\r\n* tag wiki pages or arbitrary places and quickly jump to tags\r\n* auto-formatted tables\r\n\r\nScreenshots\r\n----------------\r\n\r\n![screenshot1](https://raw.githubusercontent.com/vimwiki/vimwiki/master/doc/screenshot_1.png)\r\n![screenshot2](https://raw.githubusercontent.com/vimwiki/vimwiki/master/doc/screenshot_2.png)\r\n\r\n# Quickstart\r\nPress `<Leader>ww` (this is usually `\\ww`) to go to your index\r\npage.  By default it is located in `~/vimwiki/index.wiki`.\r\n\r\nFeed it with the following example:\r\n\r\n    = My knowledge base =\r\n        * Tasks -- things to be done _yesterday_!!!\r\n        * Project Gutenberg -- good books are power.\r\n        * Scratchpad -- various temporary stuff.\r\n\r\nPlace your cursor on `Tasks` and press Enter to create a link.  Press Enter again to\r\nopen it.  Edit the new page, save it, and press Backspace to jump back to your\r\nindex.\r\n\r\nA Vimwiki link can be constructed from more than one word.  Just visually\r\nselect the words to be linked and press Enter.  Try it with `Project Gutenberg`.\r\nThe result should look something like:\r\n\r\n    = My knowledge base =\r\n        * [[Tasks]] -- things to be done _yesterday_!!!\r\n        * [[Project Gutenberg]] -- good books are power.\r\n        * Scratchpad -- various temporary stuff.\r\n\r\nSee `:h vimwiki` for the full documentation.\r\n\r\nBasic markup (default syntax)\r\n------------------------------------------------------------------------------\r\n\r\n    = Header1 =\r\n    == Header2 ==\r\n    === Header3 ===\r\n\r\n    *bold text*\r\n    _italic text_\r\n\r\n    [[wiki link]]\r\n    [[wiki link|description]]\r\n\r\n    * bullet list item 1\r\n    * bullet list item 2\r\n        a) numbered list item 1\r\n        b) numbered list item 2\r\n\r\n    {{{python\r\n    def greet(s):\r\n        print(\"Hello, \" + s)\r\n    }}}\r\n\r\n    | a table |  |\r\n    |---------|--|\r\n    |         |  |\r\n\r\nFor other syntax elements, see `:h vimwiki-syntax`\r\n\r\nKey bindings\r\n------------------------------------------------------------------------------\r\n\r\n * `<Leader>ww` – Open the default wiki index file\r\n * `<Leader>ws` – Select and open wiki index file\r\n * `<Enter>` – Follow/Create wiki link\r\n * `<Backspace>` – Go back to parent(previous) wiki link\r\n * `<Tab>` – Find next wiki link\r\n * `<Shift-Tab>` – Find previous wiki link\r\n\r\nFor more keys, see `:h vimwiki-mappings`\r\n\r\n\r\nCommands\r\n------------------------------------------------------------------------------\r\n\r\n * `:Vimwiki2HTML` – Convert current wiki page to HTML\r\n * `:VimwikiAll2HTML` – Convert all your wiki pages to HTML\r\n \r\nFor more, see `:h vimwiki-commands`\r\n\r\nInstallation\r\n==============================================================================\r\n\r\nPrerequisites\r\n------------------------------------------------------------------------------\r\n\r\nMake sure you have these settings in your vimrc file:\r\n\r\n    set nocompatible\r\n    filetype plugin on\r\n    syntax on\r\n\r\nWithout them Vimwiki will not work properly.\r\n\r\n\r\nInstallation using [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332)\r\n------------------------------------------------------------------------------\r\n\r\n    cd ~/.vim\r\n    mkdir bundle\r\n    cd bundle\r\n    git clone https://github.com/vimwiki/vimwiki.git\r\n\r\nAlternatively, download the latest stable version ([zip](http://github.com/vimwiki/vimwiki/zipball/master) [tar](http://github.com/vimwiki/vimwiki/tarball/master)) or the latest development version ([zip](http://github.com/vimwiki/vimwiki/zipball/dev) [tar](http://github.com/vimwiki/vimwiki/tarball/dev)) and extract it into `~/.vim/bundle/`\r\n\r\nThen launch Vim, run `:Helptags` and then `:help vimwiki` to verify it was installed.",
  "google": "",
  "note": "Don't delete this file! It's used internally to help with page regeneration."
}