new documentation for homepage

This commit is contained in:
lavrton
2015-01-13 15:26:01 +07:00
parent f0056bef1c
commit c852a10d59
5 changed files with 65 additions and 15 deletions

1
.gitignore vendored
View File

@@ -5,6 +5,7 @@ node_modules
bower_components bower_components
phantomjs.exe phantomjs.exe
docs docs
homedocs
jsdoc-template jsdoc-template
test/sandbox.html test/sandbox.html

View File

@@ -220,6 +220,16 @@ module.exports = function(grunt) {
spawn: false spawn: false
} }
} }
},
jsdoc : {
dist : {
src: ['README.md', './src/**/*.js'],
options: {
destination: 'homedocs',
template : './node_modules/grunt-jsdoc/node_modules/ink-docstrap/template',
configure : './resources/jsdoc.conf.json'
}
}
} }
}; };
@@ -255,6 +265,11 @@ module.exports = function(grunt) {
'shell:jsdoc' 'shell:jsdoc'
]); ]);
grunt.registerTask('homedocs', 'Generate docs for homepage', [
'full',
'jsdoc'
]);
grunt.registerTask('hint', 'Check hint errors', ['jshint']); grunt.registerTask('hint', 'Check hint errors', ['jshint']);
grunt.registerTask('test', 'Run tests', ['dev', 'mocha_phantomjs']); grunt.registerTask('test', 'Run tests', ['dev', 'mocha_phantomjs']);
@@ -288,4 +303,5 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-shell'); grunt.loadNpmTasks('grunt-shell');
grunt.loadNpmTasks('grunt-mocha-phantomjs'); grunt.loadNpmTasks('grunt-mocha-phantomjs');
grunt.loadNpmTasks('grunt-contrib-watch'); grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-jsdoc');
}; };

View File

@@ -10,7 +10,7 @@ Greetings fellow webonauts! KineticJS is an HTML5 Canvas JavaScript framework th
You can draw things onto the stage, add event listeners to them, move them, scale them, and rotate them independently from other shapes to support high performance animations, even if your application uses thousands of shapes. Served hot with a side of awesomeness. You can draw things onto the stage, add event listeners to them, move them, scale them, and rotate them independently from other shapes to support high performance animations, even if your application uses thousands of shapes. Served hot with a side of awesomeness.
* **Visit:** The [GitHub page](http://lavrton.github.io/KineticJS/) and follow on [Twitter](https://twitter.com/lavrton) * **Visit:** The [GitHub page](http://lavrton.github.io/KineticJS/) and follow on [Twitter](https://twitter.com/lavrton)
* **Discover:** [Tutorials](http://lavrton.github.io/KineticJS/Getting_Started.html), [API Documentation](http://lavrton.github.io/KineticJS/api/) * **Discover:** [Tutorials](http://lavrton.github.io/KineticJS/Getting_Started.html), [API Documentation](http://lavrton.github.io/KineticJS/api/Kinetic.html)
* **Help:** [StackOverflow](http://stackoverflow.com/questions/tagged/kineticjs) * **Help:** [StackOverflow](http://stackoverflow.com/questions/tagged/kineticjs)
#Installation #Installation

View File

@@ -2,24 +2,26 @@
"name": "kinetic", "name": "kinetic",
"version": "5.1.9", "version": "5.1.9",
"devDependencies": { "devDependencies": {
"chai": "1.9.2",
"connect": "3.2.0",
"grunt": "0.4.5",
"grunt-cli": "0.1.13",
"grunt-contrib-clean": "0.6.0",
"grunt-contrib-concat": "0.5.0",
"grunt-contrib-copy": "~0.6.0",
"grunt-contrib-jshint": "0.10.0", "grunt-contrib-jshint": "0.10.0",
"grunt-contrib-nodeunit": "0.4.1", "grunt-contrib-nodeunit": "0.4.1",
"grunt-contrib-uglify": "0.6.0", "grunt-contrib-uglify": "0.6.0",
"grunt-contrib-concat": "0.5.0",
"grunt-replace": "0.7.9",
"grunt-contrib-clean": "0.6.0",
"mocha": "1.21.4",
"chai": "1.9.2",
"phantomjs": "1.9.10",
"mocha-phantomjs": "3.5.0",
"grunt-cli": "0.1.13",
"grunt": "0.4.5",
"connect": "3.2.0",
"grunt-contrib-copy": "~0.6.0",
"jsdoc": "~3.3.0-alpha9",
"grunt-mocha-phantomjs": "~0.6.0",
"grunt-contrib-watch": "~0.6.1", "grunt-contrib-watch": "~0.6.1",
"grunt-shell": "~1.1.1" "grunt-jsdoc": "^0.5.7",
"grunt-mocha-phantomjs": "~0.6.0",
"grunt-replace": "0.7.9",
"grunt-shell": "~1.1.1",
"ink-docstrap": "^0.4.12",
"jsdoc": "~3.3.0-alpha9",
"mocha": "1.21.4",
"mocha-phantomjs": "3.5.0",
"phantomjs": "1.9.10"
}, },
"keywords": [ "keywords": [
"canvas", "canvas",

31
resources/jsdoc.conf.json Normal file
View File

@@ -0,0 +1,31 @@
{
"tags" : {
"allowUnknownTags" : true
},
"plugins" : ["plugins/markdown"],
"templates" : {
"cleverLinks" : false,
"monospaceLinks" : false,
"dateFormat" : "ddd MMM Do YYYY",
"outputSourceFiles" : true,
"outputSourcePath" : true,
"systemName" : "KineticJS",
"footer" : "",
"copyright" : "KineticJS Copyright © 2015 The contributors to the KineticJS project.",
"navType" : "vertical",
"theme" : "cosmo",
"linenums" : true,
"collapseSymbols" : false,
"inverseNav" : true,
"highlightTutorialCode" : true,
"analytics" : {
"ua" : "UA-54202824-2",
"domain" : "http://lavrton.github.io/KineticJS"
}
},
"markdown" : {
"parser" : "gfm",
"hardwrap" : true
}
}