- Install Ruby (see .ruby-version in the project root for the exact version. I recommend using rbenv.)
- Install bundler:
gem install bundler
- Bundle:
bundle install
- Install Node (see .nvmrc in the project root for the exact version. I recommend using NVM.)
- Install yarn. Instructions
- Run
yarn install
on the command line. - Call
yarn run develop
in the console. This starts jekyll and webpack. Changes will be compiled automatically. - Open http://localhost:4000/
- To change the text on the webpage, edit
index.md
(in the project root) (you can write markdown or html there). - To add styles, see the
_sass
folder. If you add new files, make sure to import them inmain.sass
. - To add javascript, see the
_webpack
folder. Yarn is used to manage dependencies.
See http://localhost:4000/testtest/ for colors and html elements that can be reused.
Run yarn run build
on the command line. This will generate HTML etc. in the docs folder. Commit that with git and push your changes to Github. Github will display the contents of the docs
folder (without further postprocessing).