SassDoc is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye. – SassDoc.com So your team is using Sass, and everybody is whipping out amazing @mixins, @extends, custom functions, and maximizing use of all those wonderful, built-in Control Directives (@if, @for, @each, @while). Your team has a system in place for introducing new @mixins to other team members so everybody leverages the goodies. While each team understands each project’s Sass nuances and intricacies, there can be gaps in understanding for team members that are added, or even newly hired employees. This is where the often dreaded documentation can come in handy. Project like thoughbot’s Bourbon and Bourbon Neat generate and run their documentation site’s on SassDoc. Install SassDoc These instructions assume you’re running Grunt, but SassDoc has documentation on other task runners, like Gulp. You could also just install SassDoc globally as a Node package, with: # Install SassDoc globally npm install sassdoc -g And here is how I would do it (again, with Grunt): npm install --save-dev grunt-sassdoc Once the plugin is installed in your desired project be sure

SassDoc is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye. – SassDoc.com So your team is using Sass, and everybody is whipping out amazing @mixins, @extends, custom functions, and maximizing use of all those wonderful, built-in Control Directives (@if, @for, @each, @while). Your team has a system in place for introducing new @mixins to other team members so everybody leverages the goodies. While each team understands each project’s Sass nuances and intricacies, there can be gaps in understanding for team members that are added, or even newly hired employees. This is where the often dreaded documentation can come in handy. Project like thoughbot’s Bourbon and Bourbon Neat generate and run their documentation site’s on SassDoc. Install SassDoc These instructions assume you’re running Grunt, but SassDoc has documentation on other task runners, like Gulp. You could also just install SassDoc globally as a Node package, with: # Install SassDoc globally npm install sassdoc -g And here is how I would do it (again, with Grunt): npm install --save-dev grunt-sassdoc Once the plugin is installed in your desired project be sure
Share This