https://github.com/foundation/supercollider
A fancy documentation generator.
https://github.com/foundation/supercollider
Last synced: about 1 year ago
JSON representation
A fancy documentation generator.
- Host: GitHub
- URL: https://github.com/foundation/supercollider
- Owner: foundation
- License: mit
- Created: 2015-01-20T07:07:54.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T10:02:00.000Z (almost 2 years ago)
- Last Synced: 2025-05-03T15:41:39.483Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 401 KB
- Stars: 50
- Watchers: 12
- Forks: 13
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Supercollider
A fancy documentation generator that can mash up documentation from multiple sources, such as [SassDoc](http://sassdoc.com/) and [JSDoc](http://usejsdoc.org/). Used by the [Foundation](https://github.com/foundation/foundation-sites) family of frameworks.
## Features
- Combines [Markdown, SassDoc data, and JSDoc data](docs/overview.md) into compiled HTML pages.
- Supports [custom Markdown and Handlebars](docs/api.md) instances.
- Can generate a [search result list](docs/search.md) out of documentation items.
- Can be [extended](docs/adapters.md) to support other documentation generators.
## Documentation
Read the [overview section](docs/overview.md) of the documentation to get an overview of how Supercollider works. Then check out the [full documentation](docs).
## Local Development
```
git clone https://github.com/gakimball/supercollider
cd supercollider
npm install
npm test
```