Documentation generator that can combine data from multiple parsers, such as SassDoc and JSDoc.
Package: supercollider
Created by: foundation
Last modified: Tue, 12 Jul 2022 02:36:30 GMT
Version: 1.5.3
License: MIT
Downloads: 260
Repository: https://github.com/foundation/supercollider
Install
npm install supercollider
yarn add supercollider
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
Dependencies
async: ^0.9.0chalk: ^1.1.1commander: ^2.8.1escape-html: ^1.0.3extend: ^3.0.2front-matter: ^1.0.0glob: ^7.1.4glob-all: ^3.1.0gulp-util: ^3.0.7handlebars: ^4.1.2js-yaml: ^3.13.1jsdoc-api: ^5.0.2jsdoc3-parser: ^1.0.4lodash.template: >=4.5.0marked: ^2.0.0mkdirp: ^0.5.1rimraf: ^2.2.8sassdoc: ^2.7.3string-template: ^0.2.0through2: ^0.6.3vinyl-fs: ^3.0.3
