Skip to content
Personal vimwiki + GitHub Pages
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_layouts move things around May 6, 2019
_posts . May 23, 2019
benchmark-nixpkgs benchmark-nixpkgs: see also Jul 11, 2019
deploying-k8s-apps-with-kubenix new post: deploying k8s apps with kubenix Feb 19, 2019
endorsed endorsed: move badge back up Jul 1, 2019
experiment-recursive-nix
img pictures! Feb 19, 2019
.gitignore . May 6, 2019
Bash.md . Feb 17, 2019
BashReplacement.md remove table Feb 19, 2019
BuiltWithNix.md remove <> around the links May 6, 2019
BulletproofCoffee.md snapshot Aug 12, 2018
BusinessIdeas.md snapshot Aug 12, 2018
CLA.md remove <> around the links May 6, 2019
CNAME Create CNAME Feb 19, 2019
Conferences.md remove <> around the links May 6, 2019
DarkMode.md Alternative method: use add-on May 22, 2019
Depression.md . Sep 11, 2018
Diet.md remove <> around the links May 6, 2019
Fitness.md remove <> around the links May 6, 2019
Happiness.md clarify nixcon Jul 11, 2019
JiuJitsu.md . Sep 11, 2018
Keybase.md remove <> around the links May 6, 2019
Keyring.md . Feb 22, 2019
LICENSE.md remove <> around the links May 6, 2019
MCTOil.md
Nix.md remove <> around the links May 6, 2019
NixCon.md index: update project list Jul 1, 2019
Nutrition.md remove <> around the links May 6, 2019
PasswordManagement.md remove <> around the links May 6, 2019
RAILS_ENV.md tag stuff Aug 12, 2018
README.md README May 6, 2019
SecurityKeys.md . Feb 17, 2019
SlackStatus.md . May 21, 2019
Sleep.md remove <> around the links May 6, 2019
SoftwareEngineering.md write a bit about software engineering Jul 9, 2019
StemCell.md . Sep 11, 2018
Sway.md snapshot May 9, 2019
Termite.md . Feb 17, 2019
Wacom.md . Feb 17, 2019
Writing.md . Feb 17, 2019
_config.yml fix site description Jul 10, 2019
about.md fix linking May 22, 2019
diary.md . Sep 11, 2018
index.md clarify nixcon Jul 11, 2019
keybase.txt restore keybase Feb 22, 2019
macOS.md remove <> around the links May 6, 2019
symlink.sh . Jul 2, 2018
test.md update test May 6, 2019
vim-fugitive.md . May 6, 2019
vimwiki.md snapshot May 9, 2019

README.md

Personal wiki & journal + automatic GitHub pages publication

vimwiki <3 GithubPages.

Goals

  • 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.

How to create your own wiki

1. Setup vim

  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

2. Setup GitHub Pages

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

Known issues

jekyll: no autolink in markdown

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: posts are not listed

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 https://github.com/jekyll/jekyll/pull/7649 is merged in.

vimwiki: no auto-commit-and-push

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.

vimwiki: fix the link converter

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 https://github.com/vimwiki/vimwiki/pull/529 is merged in (currently in the dev branch, not master).

vimwiki: wiki links from diary are annoying

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)

You can’t perform that action at this time.