diff --git a/README.md b/README.md index 556dad0..fd8e7dd 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ $> gulp jsdoc ``` -The documentation uses [DocStrap](https://github.com/terryweiss/docstrap) and the jsdoc format, the configuration +The documentation uses [Jaguar.js](https://github.com/davidshimjs/jaguarjs-jsdoc) and the jsdoc format, the configuration file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) ### Current features ### diff --git a/README.md b/README.md index 556dad0..fd8e7dd 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ $> gulp jsdoc ``` -The documentation uses [DocStrap](https://github.com/terryweiss/docstrap) and the jsdoc format, the configuration +The documentation uses [Jaguar.js](https://github.com/davidshimjs/jaguarjs-jsdoc) and the jsdoc format, the configuration file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) ### Current features ### diff --git a/conf.json b/conf.json deleted file mode 100644 index 7a5c26c..0000000 --- a/conf.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "tags": { - "allowUnknownTags" : true - }, - "source": { - "include": ["./README.md","./src"] - }, - "plugins": ["plugins/markdown"], - "opts": { - "template": "./node_modules/jaguarjs-jsdoc", - "encoding": "utf8", - "destination": "./docs/", - "recurse": true - }, - "templates": { - "cleverLinks": true, - "monospaceLinks": true, - "default": { - "outputSourceFiles" : true - }, - "applicationName": "Pixi.js", - "disqus": "", - "googleAnalytics": "", - "openGraph": { - "title": "Pixi.js : javaScript 2D Renderer", - "type": "website", - "image": "", - "site_name": "Pixi.js", - "url": "http://www.pixijs.com/" - }, - "meta": { - "title": "Pixi.js docs" - }, - "linenums": false - }, - "markdown": { - "parser": "gfm", - "hardwrap": true, - "tags": ["examples"] - } -} \ No newline at end of file diff --git a/README.md b/README.md index 556dad0..fd8e7dd 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ $> gulp jsdoc ``` -The documentation uses [DocStrap](https://github.com/terryweiss/docstrap) and the jsdoc format, the configuration +The documentation uses [Jaguar.js](https://github.com/davidshimjs/jaguarjs-jsdoc) and the jsdoc format, the configuration file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) ### Current features ### diff --git a/conf.json b/conf.json deleted file mode 100644 index 7a5c26c..0000000 --- a/conf.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "tags": { - "allowUnknownTags" : true - }, - "source": { - "include": ["./README.md","./src"] - }, - "plugins": ["plugins/markdown"], - "opts": { - "template": "./node_modules/jaguarjs-jsdoc", - "encoding": "utf8", - "destination": "./docs/", - "recurse": true - }, - "templates": { - "cleverLinks": true, - "monospaceLinks": true, - "default": { - "outputSourceFiles" : true - }, - "applicationName": "Pixi.js", - "disqus": "", - "googleAnalytics": "", - "openGraph": { - "title": "Pixi.js : javaScript 2D Renderer", - "type": "website", - "image": "", - "site_name": "Pixi.js", - "url": "http://www.pixijs.com/" - }, - "meta": { - "title": "Pixi.js docs" - }, - "linenums": false - }, - "markdown": { - "parser": "gfm", - "hardwrap": true, - "tags": ["examples"] - } -} \ No newline at end of file diff --git a/gulp/util/jsdoc.conf.json b/gulp/util/jsdoc.conf.json index 15bb1d6..0e1fb05 100644 --- a/gulp/util/jsdoc.conf.json +++ b/gulp/util/jsdoc.conf.json @@ -31,11 +31,8 @@ "systemName" : "PIXI", "footer" : "Made with ♥ by Goodboy Digital", "copyright" : "PIXI Copyright © 2013-2015 Mat Groves.", - "navType" : "vertical", - "theme" : "cerulean", "linenums" : true, - "collapseSymbols": false, - "inverseNav" : true + "collapseSymbols": false }, "markdown" : { "parser" : "gfm", @@ -47,7 +44,6 @@ "private" : false, "lenient" : true, "destination" : "./docs", - "template" : "./node_modules/ink-docstrap/template" - + "template" : "./node_modules/jaguarjs-jsdoc" } }