2020-11-28 03:39:16 +01:00
|
|
|
# Contributing to the docs
|
|
|
|
|
|
2020-12-07 23:38:55 +01:00
|
|
|
**Note:** External components for the website (Bootstrap, jQuery, Font Awesome etc.) are
|
|
|
|
|
now being served from CDNs instead of from the repo itself. You must be connected to the internet in order to test the site.
|
|
|
|
|
|
2020-11-28 03:39:16 +01:00
|
|
|
## Running Jekyll
|
|
|
|
|
|
2020-12-07 23:38:55 +01:00
|
|
|
Follow [these instructions](https://jekyllrb.com/docs/installation/) to install Ruby, then:
|
|
|
|
|
|
2020-11-28 03:39:16 +01:00
|
|
|
```
|
2020-12-07 23:38:55 +01:00
|
|
|
# Install Jekyll and Bundler gems
|
|
|
|
|
gem install jekyll bundler
|
|
|
|
|
|
|
|
|
|
# Install Jekyll dependencies
|
|
|
|
|
cd docs #must run in docs folder
|
2020-11-28 03:39:16 +01:00
|
|
|
bundler install
|
2020-12-07 23:38:55 +01:00
|
|
|
|
|
|
|
|
# Run Jekyll server
|
2020-11-28 03:39:16 +01:00
|
|
|
jekyll serve
|
2020-12-07 23:38:55 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Where to find things
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
/docs -> main folder
|
|
|
|
|
|-- /_docs -> actual documentation lives here in markdown files
|
|
|
|
|
|-- /_includes -> the equilivant of components, can be inserted into HTML files
|
|
|
|
|
|-- /_layouts -> the HTML styling templates that make up each page
|
|
|
|
|
|-- /css -> CSS files live here
|
|
|
|
|
|-- /img -> all images, screenshots live here
|
|
|
|
|
|-- _config.yml -> main settings file for Jekyll
|
|
|
|
|
|-- Gemfile -> dependencies file for Jekyll
|
|
|
|
|
```
|
