vimwiki <3 GithubPages.

• Jekyll should support the same markdown features as GitHub. Markdown should be previewable on GitHub.
• vimwiki should be tweaked to produce content for Jekyll.
• vimwiki can be used both for the wiki and journaling.
• the diary feature of vimwiki will generate Jekyll posts.

1. Install the vimwiki plugin
2. Optionally install the Calendar plugin
3. Add the following in your ~/.vimrc:

let wiki_1 = {}
let wiki_1.path = '~/vimwiki'
let wiki_1.ext = '.md'
let wiki_1.syntax = 'markdown'
let wiki_1.auto_toc = 1
" Create posts automatically
let wiki_1.diary_rel_path = '_posts'
let g:vimwiki_list = [wiki_1]
let g:vimwiki_dir_link = 'index'
let g:vimwiki_use_calendar = 1

1. Create a new repo
2. Set "master" as the gh-pages branch:
3. Add a _config.yml (see this repo)

This is fixed by switching the markdown rendered in the _config.yml:

markdown: CommonMarkGhPages
# see https://github.com/gjtorikian/commonmarker#parse-options
commonmark:
  options:
    - FOOTNOTES
    - SMART
  extensions:
    - autolink
    - strikethrough
    - table

Jekyll requires the post to also contain a slug name.

• Works: _posts/2019-05-06-foo.md
• Doesn't work: _posts/2019-05-06.md

But since this is a journal it doesn't make sense to have a title for every day. And vimwiki doesn't support it anyways.

This will become possible once jekyll/jekyll#7649 is merged in.

It's easy to forget to commit and push the changes.

:Gwrite + :Gcommit + :Gpush from vim fugitive is quite handy but still a bit too many commands.

By default vimwiki turns Foo into [Foo](Foo) but GitHub doesn't know how to follow those links. It would be better if it was [Foo](Foo.md) instead.

This will be fixed once vimwiki/vimwiki#529 is merged in (currently in the dev branch, not master).

I don't think this is going to change.

When linking to the wiki from the diary, add a slash in front of the page name. Then type Enter to expand it.

Eg: /Foo will convert to [Foo](/Foo)