supercollider

Documentation generator that can combine data from multiple parsers, such as SassDoc and JSDoc.

Usage no npm install needed!

<script type="module">
  import supercollider from 'https://cdn.skypack.dev/supercollider';
</script>

README

Supercollider

A fancy documentation generator that can mash up documentation from multiple sources, such as SassDoc and JSDoc. Used by the Foundation family of frameworks.

Features

Combines Markdown, SassDoc data, and JSDoc data into compiled HTML pages.
Supports custom Markdown and Handlebars instances.
Can generate a search result list out of documentation items.
Can be extended to support other documentation generators.

Documentation

Read the overview section of the documentation to get an overview of how Supercollider works. Then check out the full documentation.

Local Development

git clone https://github.com/gakimball/supercollider
cd supercollider
npm install
npm test