foodocs

nkrusch · Apr 23, 2018 · 8035aee · 8035aee
1 parent 95e5109
commit 8035aee
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 14 deletions.
diff --git a/config/docs.config.json b/config/docs.config.json
@@ -6,7 +6,8 @@
         ]
     },
     "source": {
-        "include": [ 
+        "include": [
+            "README.md",
             "src"
         ],
         "includePattern": ".js$",
@@ -16,15 +17,38 @@
         "plugins/markdown"
     ],
     "templates": {
-        "cleverLinks": false,
-        "monospaceLinks": true,
-        "useLongnameInNav": false
+        "systemName": "Sitemap Generator",
+        "systemSummary": "<img src='http://inch-ci.org/github/pikkumyy/sitemap-generator.svg?branch=master' alt='badge' /> You are viewing application source code documentation. <br/>To view details about this projects please see <a href='http://www.sneeak.com/sitemap-generator' style='color:#fff'>sneeak.com/sitemap-generator</a>",
+        "systemColor": "#009688",
+        "footer": "",
+        "copyright": "",
+        "includeDate": "true",
+        "dateFormat": "MMM YYYY",
+        "inlineNav": "true",
+        "inverseNav": "false",
+        "linenums": "true",
+        "showTableOfContents": "true",
+        "showAccessFilter": "true",
+        "analytics": {
+            "ua": "UA-81731558-12",
+            "domain": "http://www.sneeak.com/sitemap-generator/docs/documentation"
+        },
+        "collapseSymbols": "true",
+        "methodHeadingReturns": "false",
+        "outputSourceFiles": "true",
+        "outputSourcePath": "true",
+        "search": "true",
+        "favicon": "./assets/img/128x128.png",
+        "stylesheets": [
+            "data:text/css;base64,Zm9vdGVyewogICAgZGlzcGxheTpub25lIWltcG9ydGFudDsKfQ=="
+        ],
+        "scripts": []
     },
     "opts": {
-        "destination": "./docs/docs.json",
+        "destination": "./docs/documentation",
         "encoding": "utf8",
         "private": true,
         "recurse": true,
-        "template": "./node_modules/jsdoc-json"
+        "template": "./node_modules/foodoc/template"
     }
 }
diff --git a/gulpfile.js b/gulpfile.js
@@ -19,12 +19,6 @@ gulp.task('default', [
     'watch'
 ]);
 
-gulp.task('doc-dir', function () {
-if (!fs.existsSync('docs')){
-    fs.mkdirSync('docs');
-}
-});
-
 gulp.task('release', ['default'], function () {
     return gulp.src(paths.dist + '/**/*')
         .pipe($.zip('release.zip'))

diff --git a/package.json b/package.json
@@ -8,7 +8,7 @@
   "scripts": {
     "dev": "gulp --progress --watch --colors --env dev",
     "build": "npm run test && gulp --env build -- release",
-        "docs": "gulp doc-dir && ./node_modules/.bin/jsdoc --configure ./config/docs.config.json",
+    "docs": "./node_modules/.bin/jsdoc --configure ./config/docs.config.json",
     "test": "mocha --require babel-core/register --colors ./test/*.spec.js",
     "test:watch": "mocha --require babel-core/register --colors -w ./test/*.spec.js",
     "test:coverage": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text mocha --require babel-core/register test/*.spec.js",
@@ -30,9 +30,9 @@
     "coveralls": "^3.0.0",
     "cross-env": "^5.1.4",
     "del": "^3.0.0",
-    "jsdoc-json": "2.0.2",
     "eslint": "^4.19.1",
     "eslint-loader": "^2.0.0",
+    "foodoc": "^0.0.8",
     "gulp": "latest",
     "gulp-clean-css": "^3.9.3",
     "gulp-concat": "^2.6.1",