Skip to content

Jekyll Git-Wiki

Jekyll Page with Git-Wiki Theme🔗

âš  Obsolete, we’re using MkDocs

  1. clone skeleton repo

    1
    git clone https://github.com/Drassil/git-wiki-skeleton.git

  2. chose Gemfile from folder .env-files, e.g. Gemfile.gitlab, and copy/symlink to base folder. Then add missing gems

    1
2
3
    gem 'kramdown'
gem 'kramdown-parser-gfm'
gem 'webrick'

  3. install gems with bundle

    1
2
    bundle config set --local path '.bundle' # set gem installation folder
bundle install

  4. serve website locally for editing

    1
    bundle exec jekyll serve

  5. add note sources as Git submodules

    1
    git submodule add URL wiki/submoddir

  6. if building fails due to unsupported file names or metadata (YAML frontmatter), fix them

  7. after editing locally, copy the _site folder and serve as static website wherever you want. Alternatively build directly with

    1
    bundle exec jekyll build
Jekyll Issues🔗
  • doesn’t support Wiki-links [[...]], needs to be translated
  • Jekyll dumps all HTML files in one directory instead of keeping the subdirectory structure. This breaks relative links.
  • Something in my notes (when integrated as Git submodule) makes Jekyll fail to serve with a Liquid error on sorting. Potential causes
    • date YAML key not in proper format (e.g. yyyy-mm-dd):
      cit/Disk_encryption, lwp/AppArmor_vs_SELinux.md