These docs are made using Jekyll.
These docs use the theme created by tomjoht.
Setting Up The Docs Locally
If you would like to run the doc site locally, follow these steps.
Running the doc site locally allows you to see any changes you make before pushing to git:
- Install Jekyll
- Clone this repository
cdinto the folder containing the
bundle exec jekyll serve --baseUrl ""to start the Jekyll server
- Go to http://localhost:4000 and you should see the documentation site running locally
How to Add Pages
Contributing to the docs generally consists of two steps:
- Create a markdown page in the
- Make sure to give the page an appropriate
key: valuepairs (i.e.
folder, etc.) at the top of the page. You can check the existing pages for examples.
- Next, open
- In this file, you will need to add the page you created to the sidebar. This ensures the page you created appears in the right place. You can take a look at existing pages to get an idea.