Website for TidalCycles
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
WebDirt @ f6f516d test/demo of rendering examples through an estuaryWebSocket Jun 1, 2016
_credits integration with blog and link to we.lurk.org Jan 12, 2018
_data towards consistent brand identity Mar 19, 2017
_functions render issue Jul 31, 2018
_getting_started remove Windows chocolatey install instructions Nov 13, 2018
_hacking/patterns [add] new documentation Nov 23, 2014
_howtos Update index.md Jul 29, 2017
_includes [add] web analytics with piwik Jan 31, 2016
_layouts integration with blog and link to we.lurk.org Jan 12, 2018
_patterns Update shifting-time.md Nov 12, 2018
_sass use Helvetica/Arial for body-copy Mar 24, 2017
_videos switch in youtube playlists Mar 7, 2017
bin quieten Mar 13, 2017
css Update tidal.scss Apr 26, 2017
favicon move favicon to separate dir, and improve page title Feb 24, 2015
fonts [add] new documentation Nov 23, 2014
img Merge branch 'master' of https://github.com/tidalcycles/tidalcycles.g… Apr 18, 2017
js use just one audio element for examples Mar 13, 2017
patterns renders May 6, 2017
samples @ 69f0d8d samples May 30, 2016
.gitignore added instructions for auto-starting superdirt from supercollider sta… Sep 27, 2017
.gitmodules add samples May 30, 2016
Dockerfile [add] docker(-compose) file for local edits Dec 4, 2016
Gemfile integration with blog and link to we.lurk.org Jan 12, 2018
Gemfile.lock integration with blog and link to we.lurk.org Jan 12, 2018
README.md [add] gh-pages and jekyll links Nov 24, 2015
_config.yml twiddles May 22, 2016
community.md integration with blog and link to we.lurk.org Jan 12, 2018
credits.md twiddles May 22, 2016
docker-compose.yml [++] bind on public interface Jan 8, 2017
docs.md [add] new documentation Nov 23, 2014
favicon.ico favicon Feb 23, 2015
functions.md replace out-of-date stuff on applicative functors.. Apr 18, 2017
getting_started.md clarify installation and add alternative synths bit May 22, 2016
googlec1f8f78d3bac0fa1.html hmm Jan 22, 2017
hacking.md [add] new documentation Nov 23, 2014
howtos.md [add] new documentation Nov 23, 2014
index.md fix blockquote overflow issues and navbar fixation Mar 22, 2017
params.json Create gh-pages branch via GitHub Jun 26, 2014
patterns.md more renders Mar 12, 2017
robots.txt permissive Mar 7, 2017
testScore.json using a real test JSON score, and enabling/disabling buttons May 30, 2016
videos.md remove hej Apr 10, 2015

README.md

tidalcycles.github.io

Website for Tidal

See the actual website here: http://tidal.lurk.org.

The documentation is a Github Page based on Jekyll

Extending the documentation

To help adding more chapters or sections on the page a few steps are necessary.

The main configuration file for all chapters and sections is found in _data/chapters.yml

This file is a YAML Collection of all chapters of the documentation.

Chapters

For each entry there is:

  • a corresponding markdown file with the same name (e.g. the first list entry is named getting_started and the folder is named getting_started.md)
  • a corresponding folder with the same name prefixed with an underscore (e.g. the first list entry is named getting_started and the folder is named _getting_started).

Each chapter also has a title that is displayed in the menu and another collection of sections.

Sections

Each section has a name and a title. While the title determines the sidebar menu label, the name is used to make a separate markdown files that live in the corresponding chapter folder to appear in a certain section. The order of sections in the configuration file, determines the order in the sidebar menu.

Example: Adding content

To add a new function description within the functions chapter in the transitions section. Place a file within _functions/transitions/your_new_transition.md.

Every new markdown file needs to start with a YAML prelude like this:

---
title: Your transition name
category: transitions
---

after the prelude, you can write standard markdown for the contents. The title will be displayed as the title of your function description and the category is the name of the section, your description should be placed in.

Note that placing your_new_transition.md in the subdirectory transitions is not strictly necessary, setting the category however is! Using subdirectories just makes it easier to navigate through the separate files.

Influencing the order of Content

The order of entries within a section of a chapter is always alphabetical. You can however use the weight key in your YAML prelude to have your content appear more likely on top or in the bottom of the chosen section. Weight is given in numeric values where negative values are light and will move you content to the top, while positive values are heavy and will let your content sink to the bottom. Note that weight is not an absolute position, but merely a relative way place content.