SassDoc

SassDoc was inspired and modeled after JSDoc.

Just like any other documentation generator, SassDoc works by grabbing comments from SASS/SCSS files and creating a beautiful, well-organized HTML documentation page out of them.

All content is well structured into sections for dealing with functions, variables, and mixins. References to the original code snippets and source code highlighting is also supported.

Besides the standard SassDoc theme, other templates are also available.

To use SassDoc please check its documentation first for the appropriate information about how to format SASS/SCSS source code comments so they can be detected and used by SassDoc's engine.

What is new in this release:

• Upgrade to Babel 5.0
• Ensure default theme name is properly logged
• Several dependencies updates
• Switched to ESLint

What is new in version 2.1.1:

• Update sass-convert version to prevent the 6to5-runtime issue described in.

What is new in version 2.0.0:

• The whole API has been fully refactored in ES6
• $ sign is now optional when defining the name in @parameter annotation
• It is now possible to use file/folder exclusion patterns
• It is now possible to pipe SassDoc into stdin
• --debug option has been added to output information about current setup
• Default theme now has a googleAnalytics configuration accepting a Google Analytics tracking key
• Default theme now has a trackingCode configuration accepting an arbitrary HTML snippet to be included before </body>
• @content annotation is now correctly output in default theme
• Default theme now displays the type as well as the name when cross-linking items (requirements, and so on...)
• Error messages should now be more explicit, providing a file name and a line
• --parse option has been added to output raw parsing data as JSON from the CLI

What is new in version 1.10.6:

• Ensure proper type checking for @see annotation.

What is new in version 1.10.3:

• Prevented @requires to autofill dependency twice.

What is new in version 1.8.0:

• Added ability to add your own annotations to your theme
• Fixed an issue with items being randomly ordered

What is new in version 1.6.0:

• Added a Yeoman Generator to make it easier to build themes.
• Added YAML support for configuration files; default configuration file name is still view, either as .json, .yaml or .yml.
• Added a message to warn against relying on the default configuration file name (view.{json,yaml,yml}) since it will break in version 2.0.0 in favor of .sassdocrc (which will support both format at once while being more semantic, less confusing and less likely to conflict with other projects).
• Fixed an issue when variable items' value contains a semi-colon.
• Improved the light theme (better sidebar toggle with states stored in localStorage, better code toggle, better JavaScript structure, and better performance).

What is new in version 1.5.2:

• Added implicit type for required placeholders

What is new in version 1.4.1:

• Fixed a broken test.

What is new in version 1.3.2:

• Fixed a broken test.

What is new in version 1.1.6:

• Backport, fixed found-at with absolute path.

Requirements:

• Node.js