doc template

doc/jsdoc-tmpl/Gruntfile.js

@@ -0,0 +1,123 @@
+/**
+ * http://gruntjs.com/configuring-tasks
+ */
+module.exports = function (grunt) {
+    var path = require('path');
+    var DEMO_PATH = 'demo/dist';
+    var DEMO_SAMPLE_PATH = 'demo/sample';
+
+    grunt.initConfig({
+        pkg: grunt.file.readJSON('package.json'),
+
+        connect: {
+            options: {
+                hostname: '*'
+            },
+            demo: {
+                options: {
+                    port: 8000,
+                    base: DEMO_PATH,
+                    middleware: function (connect, options) {
+                        return [
+                            require('connect-livereload')(),
+                            connect.static(path.resolve(options.base))
+                        ];
+                    }
+                }
+            }
+        },
+
+        watch: {
+            options: {
+                livereload: true
+            },
+            less: {
+                files: ['less/**/*.less'],
+                tasks: ['less']
+            },
+
+            lesscopy: {
+                files: ['static/styles/jaguar.css'],
+                tasks: ['copy:css']
+            },
+
+            jscopy: {
+                files: ['static/scripts/main.js'],
+                tasks: ['copy:js']
+            },
+
+            jsdoc: {
+                files: ['**/*.tmpl', '*.js'],
+                tasks: ['jsdoc']
+            }
+        },
+
+        clean: {
+            demo: {
+                src: DEMO_PATH
+            }
+        },
+
+        jsdoc: {
+            demo: {
+                src: [
+                    DEMO_SAMPLE_PATH + '/**/*.js',
+
+                    // You can add README.md file for index page at documentations.
+                    'README.md'
+                ],
+                options: {
+                    verbose: true,
+                    destination: DEMO_PATH,
+                    configure: 'conf.json',
+                    template: './',
+                    'private': false
+                }
+            }
+        },
+
+        less: {
+            dist: {
+                src: 'less/**/jaguar.less',
+                dest: 'static/styles/jaguar.css'
+            }
+        },
+
+        copy: {
+            css: {
+                src: 'static/styles/jaguar.css',
+                dest: DEMO_PATH + '/styles/jaguar.css'
+            },
+
+            js: {
+                src: 'static/scripts/main.js',
+                dest: DEMO_PATH + '/scripts/main.js'
+            }
+        }
+    });
+
+    // Load task libraries
+    [
+        'grunt-contrib-connect',
+        'grunt-contrib-watch',
+        'grunt-contrib-copy',
+        'grunt-contrib-clean',
+        'grunt-contrib-less',
+        'grunt-jsdoc',
+    ].forEach(function (taskName) {
+        grunt.loadNpmTasks(taskName);
+    });
+
+    // Definitions of tasks
+    grunt.registerTask('default', 'Watch project files', [
+        'demo',
+        'connect:demo',
+        'watch'
+    ]);
+
+    grunt.registerTask('demo', 'Create documentations for demo', [
+        'less',
+        'clean:demo',
+        'jsdoc:demo'
+    ]);
+};

doc/jsdoc-tmpl/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Sangmin, Shim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

doc/jsdoc-tmpl/README.md

@@ -0,0 +1,55 @@
+Jaguar.js template for JSDoc 3
+---
+- [Jaguar.js](http://davidshimjs.github.io/jaguarjs)
+- [Jaguar.js Documentations](http://davidshimjs.github.io/jaguarjs/doc)
+- [JSDoc3](https://github.com/jsdoc3/jsdoc)
+- [JSDoc3 API Documentations](http://usejsdoc.org)
+
+Usage
+---
+1. If you want to create documentations with sample files, you can use commands below.
+```
+$ npm install
+$ grunt demo
+```
+
+2. You can see any output related jsdoc process with a `--debug` flag.
+```
+$ grunt demo --debug
+```
+
+3. If you already have jsdoc system, you can use this project as jsdoc template.
+```
+$ jsdoc -t `project folder` -c `configuration file` `source files` `README.md file`
+```
+
+conf.json
+---
+You can set options for customizing your documentations.
+
+```
+"templates": {
+    "applicationName": "Demo",
+    "disqus": "",
+    "googleAnalytics": "",
+    "openGraph": {
+        "title": "",
+        "type": "website",
+        "image": "",
+        "site_name": "",
+        "url": ""
+    },
+    "meta": {
+        "title": "",
+        "description": "",
+        "keyword": ""
+    }
+}
+```
+
+License
+---
+This project under the MIT License. and this project refered by default template for JSDoc 3.
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/davidshimjs/jaguarjs-jsdoc/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

doc/jsdoc-tmpl/conf.json

@@ -0,0 +1,33 @@
+{
+	"tags": {
+		"allowUnknownTags" : true
+	},
+	"plugins": ["plugins/markdown"],
+	"templates": {
+		"cleverLinks": true,
+		"monospaceLinks": true,
+		"default": {
+			"outputSourceFiles" : true
+		},
+		"applicationName": "Demo",
+		"disqus": "",
+		"googleAnalytics": "",
+		"openGraph": {
+			"title": "",
+			"type": "website",
+			"image": "",
+			"site_name": "",
+			"url": ""
+		},
+		"meta": {
+			"title": "",
+			"description": "",
+			"keyword": ""
+		}
+	},
+	"markdown": {
+		"parser": "gfm",
+		"hardwrap": true,
+		"tags": ["examples"]
+	}
+}

doc/jsdoc-tmpl/less/common.less

@@ -0,0 +1,9 @@
+@navWidth: 250px;
+@colorSubtitle: rgb(119, 156, 52);
+@colorRed: rgb(238, 125, 125);
+@colorLink: #2a6496;
+@colorBgNavi: #1a1a1a;
+
+.font-description () {
+    font-family: "freight-text-pro",Georgia,Cambria,"Times New Roman",Times,serif
+}

doc/jsdoc-tmpl/less/footer.less

@@ -0,0 +1,10 @@
+@import "common.less";
+
+footer {
+    margin: 15px 0;
+    padding-top: 15px;
+    border-top: 1px solid #e1e1e1;
+    .font-description();
+    font-size: 0.8em;
+    color: gray;
+}

doc/jsdoc-tmpl/less/jaguar.less

@@ -0,0 +1,22 @@
+@import "common.less";
+
+// normalize
+html, body {
+    font: 1em "jaf-bernino-sans","Lucida Grande","Lucida Sans Unicode","Lucida Sans",Geneva,Verdana,sans-serif;
+    background-color: #fff;
+}
+ul, ol {
+    margin: 0;
+    padding: 0;
+}
+li {
+    list-style-type: none;
+}
+
+#wrap {
+    position: relative;
+}
+
+@import "navigation.less";
+@import "main.less";
+@import "footer.less";