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