This repository contains the source code for the SlimeKnights Developer Documentation. Upon new commits, it will automatically update the site at https://slimeknights.github.io/.
This site is coded using Jekyll with the minima v2.5 theme
If you wish to contribute to development of the SlimeKnights documentation, you can do a lot of it directly using the editor on GitHub. However, the best way would be to clone the repository locally, then install Jekyll to allow you to preview your changes on a local site before committing or making a pull request.
To do this, first follow the instructions to install Jekyll and Bundler on your system. Assuming you already have Ruby installed, this should be as simple as
gem install jekyll bundler
Once Jekyll and Bundler are installed, you can launch the website using
bundle exec jekyll serve
Which will make it available at http://localhost:4000.