How to update the pretty wiki with changes from the original wiki
- clone repository
- cd into project directory
- run
bash build.sh
. On Windows you might have to use WSL, Cygwin (with Python3), or similar. This:
- pulls the latest markdowns from the original Wiki
- copies/replaces them into/in the
docs/
directory
- processes the markdown (with Python scripts) so that it becomes digestible by Jekyll (especially Wiki link formatting)
- review the changes in your favourite git client
- (optional) render locally (see below) and inspect
- if happy, commit and push the changes back to the repository
How to change website design and layout
To change the website layout follow instructions by Theme creators (Github supported Minimal theme): https://github.com/pages-themes/minimal
The changes made to the theme so far are in:
docs/_layouts/default.html
docs/assets/css/style.scss
Rendering locally
- Install Jekyll according to instructions for your OS: https://jekyllrb.com/docs/installation/
- in docs folder run
bundle install
- in docs folder run
bundle exec jekyll serve