Skip to content

Commit

Permalink
make docs official
Browse files Browse the repository at this point in the history
  • Loading branch information
capital-G committed May 18, 2024
1 parent 2c93322 commit fcd1a69
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# SuperCollider documentation

The aim of this repository is to provide a transparent and semi-official way of deploying the documentation of SuperCollider into the web.
This repository builds the official documentation of SuperCollider on the web which is located at [docs.supercollider.online](https://docs.supercollider.online).
It is built and deployed every week based on the source files of the latest major version of SuperCollider.

* [x] Changes source code links to the hosted files on GitHub
* [x] Stays automatically up-to-date and makes the build process transparent
* [x] Allows for CSS patches which creates a better UX on bigger screens (see `custom.css`)
The following enhancements and adjustments have been made to the documentation:

Currently this only includes the documentation of the sclang core and not any Extensions.
Feel free to create a Pull Request to include any
* [x] Links to source files are heading to the source files on GitHub instead of a local copy.
* [x] 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](https://baryon.supercollider.online).

This repository contains all the necessary build steps for the documentation and uses [GitHub Pages](https://pages.github.com/) 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

Expand All @@ -32,7 +39,7 @@ docker run -v ${PWD}/build:/root/scdocs scdocs /root/build_docs.sh
To access the docs in a webserver way it is possible to use a lightweight development web server via Python

```
```shell
cd build && python3 -m http.server
```

Expand Down

0 comments on commit fcd1a69

Please sign in to comment.