Introduction
SassDocify is a little command-line tool that helps you to publish a GitHub Pages site with your SassDoc-powered documentation. It creates a gh-pages branch in the current git repository, and documents the <src> directory within it.
Important: SassDocify is a shell script and will work only on Unix systems (tested successfully on MacOS, Linux and BSD). If you run Windows, you can still use it through MinGW or a similar Unix tool set for Windows, though these haven't been tested.
Installation
npm install -g sassdocifyUsage
sassdocify [options] [<src>]If <src> is not given, it’s set to the current directory.
Options
| Option | Role |
|---|---|
-h, --help |
Show help. |
-V, --version |
Show version. |
-m, --message |
Set the Git commit message. |
Examples
Document current directory in a gh-pages branch of the current repository.
sassdocifyUse custom SassDoc options:
SASSDOC='sassdoc --verbose' sassdocifyGive the source directory:
sassdocify stylesheetsCustom Git commit message:
sassdocify -m 'New SassDoc theme'