sintonia/docs
jo efe4fa027e Format code using prettier 2021-06-04 17:04:53 +02:00
..
_docs Format code using prettier 2021-06-04 17:04:53 +02:00
_includes Switching from in-repo hosting plugins to CDNs 2020-12-06 18:43:18 -05:00
_layouts Fixing typos 2020-12-08 09:36:16 -05:00
api Format code using prettier 2021-06-04 17:04:53 +02:00
css This is better 2020-12-03 12:21:39 -05:00
img feat(mvc): add preview mode setting 2021-01-06 13:48:33 +00:00
.gitignore Enhance .gitignore 2021-05-29 15:44:36 +02:00
404.md Format code using prettier 2021-06-04 17:04:53 +02:00
CNAME Create CNAME 2020-05-19 23:24:11 +02:00
Gemfile Adding back Gemfile 2020-12-03 11:19:48 -05:00
README Adding docs readme 2020-12-07 17:38:55 -05:00
_config.yml Format code using prettier 2021-06-04 17:04:53 +02:00
docs.html Fixing typos 2020-12-08 09:36:16 -05:00
favicon.ico Making working favicon 2020-05-25 17:49:06 -04:00
index.md Format code using prettier 2021-06-04 17:04:53 +02:00
lunr.js Added Lunr.js site search, fixed errors with jekyll serve 2020-11-14 21:34:21 -05:00
search.html More work on docs 2020-11-23 13:58:55 -05:00

README

# Contributing to the docs

**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.

## Running Jekyll

Follow [these instructions](https://jekyllrb.com/docs/installation/) to install Ruby, then:

```
# Install Jekyll and Bundler gems
gem install jekyll bundler

# Install Jekyll dependencies
cd docs  #must run in docs folder
bundler install

# Run Jekyll server
jekyll serve
```

## 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
```