The documentation HTML is produced with the Ruby-based jekyll tool.
Make sure Ruby 2.x is installed.
The Sass compiler uses NodeJS.
Make sure NodeJS is installed.
Our style guide is hosted on AWS so we need tools to push code there. You will need to get AWS credentials and authenticate your command tools.
- Clone the repo
git clone git@github.com:planswell/bulma.git styleguide
cd styleguide
npm install
gem install jekyll
- In a terminal
npm run start-docs
- In another terminal,
cd docs
jekyll serve --incremental --config _config.local.yml --port 4010
- Open a browser to
http://localhost:4010
- Now open an editor and edit
docs/_sass/planswell.scss
Save the files, refresh the browser, and you should see the changes.
- Push to git
git commit -am "<describe changes>"
git push origin master
- Push to AWS (might not be needed unless HTML is changed)
cd docs
jekyll build
aws s3 sync ./_site s3://styleguide.planswell.ca