A Markdown to HTML converter for .md files that were created with Vimwiki
Branch: master
Clone or download
maqiv Merge pull request #1 from aignas/patch-1
Update main.go to work with install instructions
Latest commit ab15db8 Nov 20, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
vimwiki add various comments Aug 8, 2017
.gitignore add gitignore Jul 4, 2017
LICENSE cleanup license file Aug 3, 2017
README.md
main.go Update main.go to work with install instructions Nov 3, 2018

README.md

Vimwiki-GoDown

Vimwiki-GoDown is a Markdown to HTML converter for .md files that were created with Vimwiki. The converter is implemented in Golang. It's idea is based on the preceding implementation mikasa_md2html, which is written in Python.

To convert Markdown syntax to HTML, Vimwiki-GoDown uses the Blackfriday Markdown processor. The only conversion that is done manually are checkboxes.

One of the main reasons behind creating another Markdown to HTML converter for Vimwiki is that, compared to other converters, Vimwiki-GoDown has the additional ability to prefix relative links to other Vimwiki pages. This means that the converted HTML files can be hosted in a subdirectory, or rather a URL subpath (of course it can also be used without prefixing links between Vimwiki pages).

Installation

To run Vimwiki-GoDown, an installation of Golang (Go 1 or above) is required. The following command will install Vimwiki-GoDown into the $GOPATH/bin directory:

go get "github.com/maqiv/vimwiki-godown"

Please make sure that the environment variable $GOPATH is set correctly and $GOPATH/bin is included in the $PATH environment variable. For more information please consult the Golang $GOPATH environment variable.

Configuration

To get Vimwiki-GoDown running with Vimwiki only a few settings need to be configured. Parameters that need to be adjusted can be found in the ~/.vim/vimrc configuration file or rather in the variable g:vimwiki_list. The two parameters that are required for Vimwiki-GoDown are:

  • custom_wiki2html: Path to the Vimwiki-GoDown binary
  • custom_wiki2html_args: URL Subpath that is prefixed to every relative link between Vimwiki pages

Example:

let g:vimwiki_list = [{
...
  \'custom_wiki2html': '$GOPATH/bin/vimwiki-godown',
  \'custom_wiki2html_args': 'xyz/',
...
\}]

More information about the parameters can be found in the Vimwiki help.

License

This software is distributed under the MIT license.

ToDo

  • Possibility to use templates
  • Ensure compatility to percent codes used in misaka_md2html.py
  • Customize title guessing so that TOC heading is not used as title
  • .... any additional ideas or contributions are very welcome :-)