Starting from version 2.0 and higher SassDoc is able to integrate directly in
your Gulp pipelines without any plugin. In such the gulp-sassdoc plugin has been deprecated.
If you haven’t used Gulp before, be sure to check out the Getting started guide,
as it explains how to create a Gulpfile as well as install and use Gulp plugins.
Bare minimum example, using defaults or .sassdocrc
Example with some options passed in
Example adding support for Sass (indented syntax) files
Example of a Sassy workflow
Notes on SassDoc’s stream API
Example of a non Gulp pipeline
SassDoc Stream API is not tight to Gulp, its only requirement is
expecting Vinyl files passed trough. The vinyl-source-stream module
might comes in handy.
Note: the end event emitted by SassDoc's stream refers to the end of
the parsing phase. If you want to await for the full documentation process to
end, SassDoc is attaching a promise. This might be interesting if you run a
sequence of tasks.
On projects with a relatively high number of files, and if SassDoc is the last
stream of the pipeline, you might need to release the back pressure and trigger
flowing mode, aka "drain". This is imposed by how Streams 2 works.