website

Documentation

This directory houses the source files used for creating the documentation portion of the Krayon GitHub Pages website.

The documentation website is powered by Jekyll, the necessary prerequisites can be setup via:

brew install ruby

Add the following to the end of your ~/.zshrc file:

Apple silicon

if [ -d "/opt/homebrew/opt/ruby/bin" ]; then
  export PATH=/opt/homebrew/opt/ruby/bin:$PATH
  export PATH=`gem environment gemdir`/bin:$PATH
fi

Intel Mac

if [ -d "/usr/local/opt/ruby/bin" ]; then
  export PATH=/usr/local/opt/ruby/bin:$PATH
  export PATH=`gem environment gemdir`/bin:$PATH
fi

gem install bundler jekyll

./gradlew :website:browserRun