sintonia/docs
Kyle Robbertze 7182390000
feat: add support for Ubuntu Focal 20.04 (#1168)
Co-authored-by: Valerio Bozzolan <gnu@linux.it>
2021-11-04 09:55:50 +02:00
..
_docs feat: add support for Ubuntu Focal 20.04 (#1168) 2021-11-04 09:55:50 +02:00
_includes Fix end of files 2021-06-04 17:06:05 +02:00
_layouts Fix end of files 2021-06-04 17:06:05 +02:00
api Format code using prettier 2021-06-04 17:04:53 +02:00
css Replace some em dash with en dash 2021-06-05 00:39:35 +02:00
img Fix executable bit 2021-06-04 17:06:05 +02: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 Fix end of files 2021-06-04 17:06:05 +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 Fix end of files 2021-06-04 17:06:05 +02:00
favicon.ico Making working favicon 2020-05-25 17:49:06 -04:00
index.md Update Website link to point to alpha.10 (#1404) 2021-10-16 23:54:00 +02:00
lunr.js Added Lunr.js site search, fixed errors with jekyll serve 2020-11-14 21:34:21 -05:00
search.html Fix end of files 2021-06-04 17:06:05 +02: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
```