camomile-project/camomile-project.github.io

Documentation (served at http://camomile-project.github.io)

Camomile documentation

Installation

bundle install
pip install ghp-import

Warning

Do not edit master branch directly. Use source branch instead.

git checkout source

Edition

bundle exec middleman server

http://localhost:4567 should automagically reflect the changes you make to source/*

Deployment

Once you are happy with what you are seeing at http://localhost:4567 , you can deploy the documentation (from the source branch) with this:

bundle exec middleman build
export COMMIT_MESSAGE=""
ghp-import -n -p -m $COMMIT_MESSAGE -b master build

This will automagically commit and push the content of the build directory to the repository master branch -- served at http://camomile-project.github.io.