From e18763793ab284d2091c9caba094b860c046b999 Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Fri, 15 Apr 2016 06:50:21 -0700 Subject: [PATCH] add jsdoc config. --- .npmignore | 6 ++++++ jsdoc.json | 24 ++++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 .npmignore create mode 100644 jsdoc.json diff --git a/.npmignore b/.npmignore new file mode 100644 index 000000000..ceeadf61c --- /dev/null +++ b/.npmignore @@ -0,0 +1,6 @@ +.git* +test/ +node_modules/ +.jshintrc +.jscsrc +jsdoc.json diff --git a/jsdoc.json b/jsdoc.json new file mode 100644 index 000000000..ad6db37d8 --- /dev/null +++ b/jsdoc.json @@ -0,0 +1,24 @@ +{ + "tags": { + "allowUnknownTags": true + }, + "source": { + "include": ["README.md", "lib/"], + "exclude": [], + "includePattern": ".+\\.js(doc)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "plugins": ["plugins/markdown"], + "templates": { + "cleverLinks": false, + "monospaceLinks": false + }, + "opts": { + "template": "templates/default", + "encoding": "utf8", + "destination": "./docs/", + "recurse": true, + "private": true, + "pedantic": true + } +}