{"id":18918008,"url":"https://github.com/supercollider/sc-docs","last_synced_at":"2026-03-12T03:30:17.626Z","repository":{"id":199692649,"uuid":"703459414","full_name":"supercollider/sc-docs","owner":"supercollider","description":"SuperCollider documentation for the web","archived":false,"fork":false,"pushed_at":"2024-05-22T01:06:43.000Z","size":5370,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-22T02:26:39.788Z","etag":null,"topics":["docs","supercollider"],"latest_commit_sha":null,"homepage":"https://docs.supercollider.online","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/supercollider.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-11T09:32:33.000Z","updated_at":"2024-05-22T02:26:41.701Z","dependencies_parsed_at":"2023-10-22T02:32:02.573Z","dependency_job_id":"9b1baa66-8306-4bb7-9e36-73b0ad9a50be","html_url":"https://github.com/supercollider/sc-docs","commit_stats":null,"previous_names":["capital-g/sc-docs","supercollider/sc-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Fsc-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Fsc-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Fsc-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/supercollider%2Fsc-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/supercollider","download_url":"https://codeload.github.com/supercollider/sc-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239914933,"owners_count":19717760,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","supercollider"],"created_at":"2024-11-08T10:29:05.809Z","updated_at":"2026-03-12T03:30:17.582Z","avatar_url":"https://github.com/supercollider.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SuperCollider documentation\n\nThis repository builds the official documentation of SuperCollider on the web which is located at [docs.supercollider.online](https://docs.supercollider.online).\nIt is built and deployed every week based on the source files of the latest major version of SuperCollider.\n\nThe following enhancements and adjustments have been made to the documentation:\n\n* [x] Links to source files are heading to the source files on GitHub instead of a local copy.\n* [x] A CSS patch that limits the screen-width which improves readability on wider screens (see `custom.css`)\n\nThe documentation is limited to a vanilla installation of SuperCollider, i.e. without any plugins or Quarks.\nThe documentation for each Quark can be found at [baryon.supercollider.online](https://baryon.supercollider.online).\n\nA development version of the docs is available at [dev.docs.supercollider.online](https://dev.docs.supercollider.online/), reflecting the latest additions to the documentation in the `develop` branch.\n\nThis 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.\nThis could be replaced with any other static file hosting mechanism in the future.\n\n\u003e In case of a new major release update the branch in `Dockerfile`\n\n## Build\n\nAlthough 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.\n\nStart by building the container\n\n```shell\ndocker build -t scdocs .\n```\n\nand 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.\n\n```shell\ndocker run -v ${PWD}/build:/root/scdocs scdocs /root/build_docs.sh\n```\n\n\u003e The generated build files will be owned by the root user, so modifying\n\u003e them requires sudo rights!\n\u003e \n\u003e Use `sudo chown -R $USER build` to transfer ownership to the host user.\n\nTo access the docs in a webserver way it is possible to use a lightweight development web server via Python\n\n```shell\ncd build \u0026\u0026 python3 -m http.server\n```\n\nwhich will make the docs available under \u003chttp://localhost:8000\u003e.\n\nTo make a clean build use `rm -rf build`.\n\nMake 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.\n\n## License\n\nThis repository uses the GPL3 license.\n\nSuperCollider is free software published under the GPL: Licensing.\n\nThe help files are published under the Creative Commons CC-BY-SA-3 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupercollider%2Fsc-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsupercollider%2Fsc-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsupercollider%2Fsc-docs/lists"}