Finalize jsDoc

Author: mistic100

.jsdoc.json

@@ -0,0 +1,39 @@
+{
+  "opts": {
+    "private": false,
+    "template": "node_modules/foodoc/template",
+    "readme": "build/jsdoc.md"
+  },
+  "plugins": [
+    "plugins/markdown"
+  ],
+  "templates": {
+    "systemName": "jQuery QueryBuilder API",
+    "systemSummary": "jQuery plugin for user friendly query/filter creator",
+    "systemColor": "#004482",
+    "copyright": "Licensed under MIT License, documentation under CC BY 3.0.",
+    "includeDate": false,
+    "inverseNav": false,
+    "cleverLinks": true,
+    "sort": "longname, version, since",
+    "analytics": {
+      "ua": "UA-28192323-3",
+      "domain": "auto"
+    },
+    "navMembers": [
+      {"kind": "class", "title": "Classes", "summary": "All documented classes."},
+      {"kind": "external", "title": "Externals", "summary": "All documented external members."},
+      {"kind": "global", "title": "Globals", "summary": "All documented globals."},
+      {"kind": "mixin", "title": "Mixins", "summary": "All documented mixins."},
+      {"kind": "interface", "title": "Interfaces", "summary": "All documented interfaces."},
+      {"kind": "module", "title": "Plugins", "summary": "All documented modules."},
+      {"kind": "event", "title": "Events", "summary": "All documented events."},
+      {"kind": "namespace", "title": "Namespaces", "summary": "All documented namespaces."},
+      {"kind": "tutorial", "title": "Tutorials", "summary": "All available tutorials."}
+    ],
+    "scripts": [
+      "https://cdnjs.cloudflare.com/ajax/libs/trianglify/1.0.1/trianglify.min.js",
+      "js/custom.js"
+    ]
+  }
+}

Gruntfile.js

@@ -106,6 +106,10 @@ module.exports = function(grunt) {
                         dest: 'dist/scss/plugins/_' + name + '.scss'
                     };
                 })
+            },
+            doc_script: {
+                src: 'build/jsdoc.js',
+                dest: 'doc/js/custom.js'
             }
         },
 
@@ -263,7 +267,8 @@ module.exports = function(grunt) {
 
         // clean build dir
         clean: {
-            temp: ['.temp']
+            temp: ['.temp'],
+            doc: ['doc']
         },
 
         // jshint tests
@@ -301,11 +306,9 @@ module.exports = function(grunt) {
         jsdoc: {
             lib: {
                 src: ['src/**/*.js', '!src/**/.wrapper.js'],
-                dest: 'doc',
                 options: {
-                    private: false,
-                    template: 'node_modules/docdash',
-                    readme: 'README.md'
+                    destination: 'doc',
+                    config: '.jsdoc.json'
                 }
             }
         },
@@ -423,4 +426,10 @@ module.exports = function(grunt) {
         'connect',
         'watch'
     ]);
+
+    grunt.registerTask('doc', [
+        'clean:doc',
+        'jsdoc',
+        'copy:doc_script'
+    ]);
 };

README.md

@@ -1,17 +1,39 @@
 # jQuery QueryBuilder
 
 [![Bower version](https://img.shields.io/bower/v/jQuery-QueryBuilder.svg?style=flat-square)](http://querybuilder.js.org)
+[![npm version](https://img.shields.io/npm/v/jQuery-QueryBuilder.svg?style=flat-square)](https://www.npmjs.com/package/jQuery-QueryBuilder)
 [![CDN](https://img.shields.io/badge/cdn-jsdelivr-%23EB4C36.svg?style=flat-square)](http://www.jsdelivr.com/projects/jquery.query-builder)
 [![Build Status](https://img.shields.io/travis/mistic100/jQuery-QueryBuilder.svg?style=flat-square)](https://travis-ci.org/mistic100/jQuery-QueryBuilder)
 [![Coverage Status](https://img.shields.io/coveralls/mistic100/jQuery-QueryBuilder/master.svg?style=flat-square)](https://coveralls.io/r/mistic100/jQuery-QueryBuilder)
-[![Say thanks](https://img.shields.io/badge/SayThanks.io-%E2%98%80-1EAEDB.svg?style=flat-square)](https://saythanks.io/to/mistic100)
 
 jQuery plugin offering an simple interface to create complex queries.
 
 [![screenshot](https://raw.githubusercontent.com/mistic100/jQuery-QueryBuilder/master/examples/screenshot.png)](http://querybuilder.js.org)
 
+
+
 ## Documentation
-[querybuilder.js.org](http://querybuilder.js.org)
+[http://querybuilder.js.org](http://querybuilder.js.org)
+
+
+
+## Install
+
+#### Manually
+
+[Download the latest release](https://github.com/mistic100/jQuery-QueryBuilder/releases)
+
+#### With Bower
+
+```bash
+$ bower install jQuery-QueryBuilder
+```
+
+#### With npm
+
+```bash
+$ npm install jQuery-QueryBuilder
+```
 
 ### Dependencies
  * jQuery >= 1.10
@@ -27,7 +49,9 @@ jQuery plugin offering an simple interface to create complex queries.
  * Internet Explorer >= 9
  * All other recent browsers
 
-### Build
+
+
+## Build
 
 #### Prerequisites
 
@@ -63,8 +87,13 @@ grunt --languages=fr,it
 
  * `grunt test` to run jshint/jscs/scsslint and the QUnit test suite.
  * `grunt serve` to open the example page with automatic build and livereload.
- * `grunt jsdoc` to generate the documentation.
+ * `grunt doc` to generate the documentation.
+
+
+
+## License
+This library is available under the MIT license.
 
-### Inspiration
+#### Inspirations
  * [Knockout Query Builder](http://kindohm.github.io/knockout-query-builder/)
  * [jui_filter_rules](http://www.pontikis.net/labs/jui_filter_rules/)

build/jsdoc.js

@@ -0,0 +1,12 @@
+(function() {
+    var header = $('.page-header');
+    var pattern = Trianglify({
+        width: window.screen.width | header.outerWidth(),
+        height: header.outerHeight(),
+        cell_size: 90,
+        seed: 'jQuery QueryBuilder',
+        x_colors: ['#0074d9', '#001224']
+    });
+
+    header.css('background-image', 'url(' + pattern.png() + ')');
+}());

build/jsdoc.md

@@ -0,0 +1,11 @@
+# <i class="glyphicon glyphicon-home"></i> [Main documentation](..)
+
+# Entry point: [$.fn.QueryBuilder](external-_jQuery.fn_.html)
+
+## [QueryBuilder](QueryBuilder.html)
+
+## [Rule](Rule.html) & [Group](Group.html)
+
+## [Events](list_event.html)
+
+## [Plugins](list_module.html)

package.json

@@ -16,7 +16,7 @@
   },
   "devDependencies": {
     "deepmerge": "^0.2.0",
-    "docdash": "^0.4.0",
+    "foodoc": "git://github.com/mistic100/foodoc.git#custom",
     "grunt": "^1.0.0",
     "grunt-banner": "^0.6.0",
     "grunt-contrib-clean": "^1.0.0",