Contributing

The website hosted at https://supercollider.github.io is built with Jekyll.
Page and posts are simple markdown documents and jekyll generates these to static pages.

Fix a typo or something small

You can edit and create files directly there on github. Look for an edit link at the bottom of each page.

Visit the repository and edit the page using the github interface. This will submit a pull request to the supercollider organization. When the pull request is reviewed and accepted it will be merged in and the pages will regenerate on github. No need to clone the repository.

Run the website locally with Jekyll

You will need to have gem and jekyll installed. Check out this repository and start the server to view changes in preview mode:

bundle exec jekyll serve

Alternatively, for older jekyll versions:

jekyll --server --watch

Add news posts and pages

A post is a page that has a publish date and appears in the dated archives. It also appears in the RSS/Atom feed and in the latest news on the front page.

A page is a wiki page, simple document.

A page or post must have this YAML front matter at the top:

---
layout: page
title: "THE TITLE"
published: true
category: development
sort_order: 3
---

Pages go in category-name/page-name.md and should always have the category set in the header variables to be the same as the folder it is in. Otherwise it doesn’t show up in the page index.

Posts (announcements and news with dates) go in _posts and must include a date in the file name: YYYY-MM-DD-title-goes-here.md.

For pages you can also just create markdown files inside folders:

category/post-name.md will result in http://supercollider.github.io/category/post-name/.

Internal links are relative to the current document and should use the .html form.

See also Syntax styling and markdown

Publishing

Simply push to this repository and github will regenerate the site.