README.md in vimwiki_markdown-0.1.0 vs README.md in vimwiki_markdown-0.1.1

- old
+ new

@@ -18,16 +18,10 @@ Note, the current version of vimwiki does not allow binaries to be called for the generation of html. This was added on the master branch in [this commit](https://github.com/vimwiki/vimwiki/commit/c1a5bb51adc8cacaa70e2804106817b68295f932) Currently you will need to make sure you are running the dev branch of vimwiki, or add that commit in yourself -## Druby - -The version 0.1 introduced Druby which we use to greatly speed up the process. You might want to stick -with the 0.0.x version if things get interesting. - - ## Setup Ensure that your vimiwiki directive in your .vimrc is setup for markdown. For this we use the custom_wiki2html parameter. My .vimrc looks like this: @@ -35,9 +29,27 @@ \ 'template_default': 'default', 'syntax': 'markdown', 'ext': '.md', \ 'path_html': '~/vimwiki/site_html/', 'custom_wiki2html': 'vimwiki_markdown', \ 'template_ext': '.tpl'}] The most important part is the *'custom_wiki2html': 'vimwiki_markdown'* + +### Note for ruby 2.2 +This gem doesn't seem to work on 2.2 on osx.. seems to be a github/markup gem issue as near as I can tell. +For the moment.. use 2.1 or lower if you run into issues. + +### Fix for vimwiki links. +In vimwiki at the moment, it deletes any files in the site_html directory which do not match +against the markdown files (once they are translated into linked html). Now, in vimwiki_markdown +we use ActiveSupports paramaterized method, as it's nicer on links. If you want to have a +significant speed up, then you need to patch your vimwiki plugin to not delete files it +shouldn't be. Here are links to the relevant bits: + +1. [Add this function](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L242-247) +2. [Make the is_html_uptodate look like this](https://github.com/patrickdavey/vimwiki-1/blob/9ebca2182fcf10e1bbf61abc8b4a535ce790480d/autoload/vimwiki/html.vim#L224-241) +3. For the moment, remove the call to deleting files `call s:delete_html_files(path_html)` - will work out a way around that later, not there now. +4. Might be some other things, check the diff in the above commits or open an issue. + + ### VimWiki Template It is a requirement that your template file contain a placeholder for the syntax highlighting code to be placed. In order to do this,