Skip to content

Commit

Permalink
Add sassdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Kaelig committed Jan 18, 2016
1 parent eb39551 commit f356750
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
9 changes: 9 additions & 0 deletions .sassdocrc
@@ -0,0 +1,9 @@
{
"package": {
"title": "Sass Deprecate",
"name": "sass-deprecate",
"homepage": "https://github.com/salesforce-ux/sass-deprecate",
"description": "deprecate() is a Sass mixin that helps managing code deprecation."
},
"autofill": "false"
}
2 changes: 1 addition & 1 deletion index.scss
Expand Up @@ -27,7 +27,7 @@ $deprecate-mode: 'sensible' !default;
///
/// @return {Number}
/// @author @HugoGiraudel - Simplified by @kaelig to only convert unsigned integers
/// @see http://hugogiraudel.com/2014/01/15/sass-string-to-number/
/// @url http://hugogiraudel.com/2014/01/15/sass-string-to-number/
/// @access private
@function _d-to-number($value) {
$result: 0;
Expand Down
13 changes: 8 additions & 5 deletions package.json
Expand Up @@ -9,18 +9,21 @@
},
"author": "Salesforce and contributors",
"scripts": {
"test": "./test/spec.rb"
"test": "./test/spec.rb",
"generate-docs": "./sassdoc.sh"
},
"files": [
"index.scss",
"README.md"
],
"ignore": [
".travis.yml",
".gitignore",
"test"
"test",
"sassdoc",
"**/.*",
"sassdoc.sh"
],
"devDependencies": {
"node-sass": "^3.4.2"
"node-sass": "^3.4.2",
"sassdoc": "^2.1.19"
}
}
7 changes: 7 additions & 0 deletions sassdoc.sh
@@ -0,0 +1,7 @@
#!/bin/sh
# Generate documentation and deploy it to GitHub pages
# http://salesforce-ux.github.io/sass-deprecate/
sassdoc . sassdoc --config=.sassdocrc
git add sassdoc
git commit -m "Compile SassDoc"
git subtree push --prefix sassdoc origin gh-pages

0 comments on commit f356750

Please sign in to comment.