Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.6 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.6 KB
Raw

SuperCollider documentation

This repository builds the official documentation of SuperCollider on the web which is located at docs.supercollider.online. It is built and deployed every week based on the source files of the latest major version of SuperCollider.

The following enhancements and adjustments have been made to the documentation:

  • Links to source files are heading to the source files on GitHub instead of a local copy.
  • A CSS patch that limits the screen-width which improves readability on wider screens (see custom.css)

The documentation is limited to a vanilla installation of SuperCollider, i.e. without any plugins or Quarks. The documentation for each Quark can be found at baryon.supercollider.online.

A development version of the docs is available at dev.docs.supercollider.online, reflecting the latest additions to the documentation in the develop branch.

This repository contains all the necessary build steps for the documentation and uses GitHub Pages for hosting of the static HTML files. This could be replaced with any other static file hosting mechanism in the future.

In case of a new major release update the branch in Dockerfile

Build

Although the docs are deployed via GitHub Pages and Actions, the build process happens within a Docker container which allows local testing as well as allowing for porting to other hosting platforms.

Start by building the container

docker build -t scdocs .

and then execute it, where /root/scdocs will be the output dir within the container for the docs, so it is necessary to mount this directory on the host machine.

docker run -v ${PWD}/build:/root/scdocs scdocs /root/build_docs.sh

The generated build files will be owned by the root user, so modifying them requires sudo rights!

Use sudo chown -R $USER build to transfer ownership to the host user.

To access the docs in a webserver way it is possible to use a lightweight development web server via Python

cd build && python3 -m http.server

which will make the docs available under http://localhost:8000.

To make a clean build use rm -rf build.

Make sure to re-build the Docker image in case any files such as build_docs.sh or custom.css are changed because they are included during build time.

License

This repository uses the GPL3 license.

SuperCollider is free software published under the GPL: Licensing.

The help files are published under the Creative Commons CC-BY-SA-3 license.