Like JSDoc for your Sass files.
npm install -g sassdocSee grunt-sassdoc.
See gulp-sassdoc.
sassdoc <src> <dest> [options]Arguments:
<src>Path to your Sass folder.<dest>Path to the destination folder.
Options:
-h, --help: Bring help.--version: Show version.-v, --verbose: Run in verbose mode.-c, --config: Path to JSON file containing variables to be passed to the view.--no-update-notifier: Do not run the update notifier check.
npm install sassdoc --savevar sassdoc = require('sassdoc');
sassdoc.parse(__dirname + '/sass').then(function (items) {
console.log(items);
})var config = {
"display": {
"access": ["public", "private"],
"alias": false,
"watermark": true
},
"package": "./package.json"
}
var sassdoc = require('sassdoc');
sassdoc.documentize(source, dest, config);See Wiki.
See Wiki.
/**
* Adds `$value` at `$index` in `$list`.
*
* @author Hugo Giraudel
*
* @ignore Documentation: http://sassylists.com/documentation/#insert-nth
*
* @requires is-true
*
* @param {List} $list - list to update
* @param {Number} $index - index to add
* @param {*} $value - value to add
*
* @throws List index $index is not a number for `insert-nth`.
* @throws List index $index must be a non-zero integer for `insert-nth`.
*
* @return {List | Null}
*/
@function insert-nth($list, $index, $value) {
// ...
}
/**
* Defines whether the lib should support legacy browsers (e.g. `IE 8`).
*
* @since 1.3.37
*
* @todo Nothing. It's awesome.
*
* @link https://github.com/SassDoc/sassdoc SassDoc
*
* @type Bool
*/
$legacy-support: true !global;- SassyIcons from Pascal Duez
- SassyFilters from Pascal Duez
- SassyLists from Hugo Giraudel
- Kittn from Sascha Fuchs