\n \n \n
\n\n\n"
},
{
"path": "docs/annotated/public/stylesheets/normalize.css",
"content": "/*! normalize.css v2.0.1 | MIT License | git.io/normalize */\n\n/* ==========================================================================\n HTML5 display definitions\n ========================================================================== */\n\n/*\n * Corrects `block` display not defined in IE 8/9.\n */\n\narticle,\naside,\ndetails,\nfigcaption,\nfigure,\nfooter,\nheader,\nhgroup,\nnav,\nsection,\nsummary {\n display: block;\n}\n\n/*\n * Corrects `inline-block` display not defined in IE 8/9.\n */\n\naudio,\ncanvas,\nvideo {\n display: inline-block;\n}\n\n/*\n * Prevents modern browsers from displaying `audio` without controls.\n * Remove excess height in iOS 5 devices.\n */\n\naudio:not([controls]) {\n display: none;\n height: 0;\n}\n\n/*\n * Addresses styling for `hidden` attribute not present in IE 8/9.\n */\n\n[hidden] {\n display: none;\n}\n\n/* ==========================================================================\n Base\n ========================================================================== */\n\n/*\n * 1. Sets default font family to sans-serif.\n * 2. Prevents iOS text size adjust after orientation change, without disabling\n * user zoom.\n */\n\nhtml {\n font-family: sans-serif; /* 1 */\n -webkit-text-size-adjust: 100%; /* 2 */\n -ms-text-size-adjust: 100%; /* 2 */\n}\n\n/*\n * Removes default margin.\n */\n\nbody {\n margin: 0;\n}\n\n/* ==========================================================================\n Links\n ========================================================================== */\n\n/*\n * Addresses `outline` inconsistency between Chrome and other browsers.\n */\n\na:focus {\n outline: thin dotted;\n}\n\n/*\n * Improves readability when focused and also mouse hovered in all browsers.\n */\n\na:active,\na:hover {\n outline: 0;\n}\n\n/* ==========================================================================\n Typography\n ========================================================================== */\n\n/*\n * Addresses `h1` font sizes within `section` and `article` in Firefox 4+,\n * Safari 5, and Chrome.\n */\n\nh1 {\n font-size: 2em;\n}\n\n/*\n * Addresses styling not present in IE 8/9, Safari 5, and Chrome.\n */\n\nabbr[title] {\n border-bottom: 1px dotted;\n}\n\n/*\n * Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome.\n */\n\nb,\nstrong {\n font-weight: bold;\n}\n\n/*\n * Addresses styling not present in Safari 5 and Chrome.\n */\n\ndfn {\n font-style: italic;\n}\n\n/*\n * Addresses styling not present in IE 8/9.\n */\n\nmark {\n background: #ff0;\n color: #000;\n}\n\n\n/*\n * Corrects font family set oddly in Safari 5 and Chrome.\n */\n\ncode,\nkbd,\npre,\nsamp {\n font-family: monospace, serif;\n font-size: 1em;\n}\n\n/*\n * Improves readability of pre-formatted text in all browsers.\n */\n\npre {\n white-space: pre;\n white-space: pre-wrap;\n word-wrap: break-word;\n}\n\n/*\n * Sets consistent quote types.\n */\n\nq {\n quotes: \"\\201C\" \"\\201D\" \"\\2018\" \"\\2019\";\n}\n\n/*\n * Addresses inconsistent and variable font size in all browsers.\n */\n\nsmall {\n font-size: 80%;\n}\n\n/*\n * Prevents `sub` and `sup` affecting `line-height` in all browsers.\n */\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsup {\n top: -0.5em;\n}\n\nsub {\n bottom: -0.25em;\n}\n\n/* ==========================================================================\n Embedded content\n ========================================================================== */\n\n/*\n * Removes border when inside `a` element in IE 8/9.\n */\n\nimg {\n border: 0;\n}\n\n/*\n * Corrects overflow displayed oddly in IE 9.\n */\n\nsvg:not(:root) {\n overflow: hidden;\n}\n\n/* ==========================================================================\n Figures\n ========================================================================== */\n\n/*\n * Addresses margin not present in IE 8/9 and Safari 5.\n */\n\nfigure {\n margin: 0;\n}\n\n/* ==========================================================================\n Forms\n ========================================================================== */\n\n/*\n * Define consistent border, margin, and padding.\n */\n\nfieldset {\n border: 1px solid #c0c0c0;\n margin: 0 2px;\n padding: 0.35em 0.625em 0.75em;\n}\n\n/*\n * 1. Corrects color not being inherited in IE 8/9.\n * 2. Remove padding so people aren't caught out if they zero out fieldsets.\n */\n\nlegend {\n border: 0; /* 1 */\n padding: 0; /* 2 */\n}\n\n/*\n * 1. Corrects font family not being inherited in all browsers.\n * 2. Corrects font size not being inherited in all browsers.\n * 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome\n */\n\nbutton,\ninput,\nselect,\ntextarea {\n font-family: inherit; /* 1 */\n font-size: 100%; /* 2 */\n margin: 0; /* 3 */\n}\n\n/*\n * Addresses Firefox 4+ setting `line-height` on `input` using `!important` in\n * the UA stylesheet.\n */\n\nbutton,\ninput {\n line-height: normal;\n}\n\n/*\n * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`\n * and `video` controls.\n * 2. Corrects inability to style clickable `input` types in iOS.\n * 3. Improves usability and consistency of cursor style between image-type\n * `input` and others.\n */\n\nbutton,\nhtml input[type=\"button\"], /* 1 */\ninput[type=\"reset\"],\ninput[type=\"submit\"] {\n -webkit-appearance: button; /* 2 */\n cursor: pointer; /* 3 */\n}\n\n/*\n * Re-set default cursor for disabled elements.\n */\n\nbutton[disabled],\ninput[disabled] {\n cursor: default;\n}\n\n/*\n * 1. Addresses box sizing set to `content-box` in IE 8/9.\n * 2. Removes excess padding in IE 8/9.\n */\n\ninput[type=\"checkbox\"],\ninput[type=\"radio\"] {\n box-sizing: border-box; /* 1 */\n padding: 0; /* 2 */\n}\n\n/*\n * 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome.\n * 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome\n * (include `-moz` to future-proof).\n */\n\ninput[type=\"search\"] {\n -webkit-appearance: textfield; /* 1 */\n -moz-box-sizing: content-box;\n -webkit-box-sizing: content-box; /* 2 */\n box-sizing: content-box;\n}\n\n/*\n * Removes inner padding and search cancel button in Safari 5 and Chrome\n * on OS X.\n */\n\ninput[type=\"search\"]::-webkit-search-cancel-button,\ninput[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n/*\n * Removes inner padding and border in Firefox 4+.\n */\n\nbutton::-moz-focus-inner,\ninput::-moz-focus-inner {\n border: 0;\n padding: 0;\n}\n\n/*\n * 1. Removes default vertical scrollbar in IE 8/9.\n * 2. Improves readability and alignment in all browsers.\n */\n\ntextarea {\n overflow: auto; /* 1 */\n vertical-align: top; /* 2 */\n}\n\n/* ==========================================================================\n Tables\n ========================================================================== */\n\n/*\n * Remove most spacing between table cells.\n */\n\ntable {\n border-collapse: collapse;\n border-spacing: 0;\n}"
},
{
"path": "docs/app.js",
"content": "var express = require('express');\nvar app = express();\nvar path = require('path');\nvar livereload = require('livereload');\nvar path = path.join(process.cwd(), process.env.DIR);\nlivereload.createServer({exts: ['applyJSLive']}).watch(path);\napp.use(express.static(path));\napp.listen(9000);\n"
},
{
"path": "docs/index.html",
"content": "\n\n\n \n \n \n \n - \n \n
- \n \n\n
dokker.js
\n \n \n \n \n - \n \n \n\n \n\n ¶\n\n
\nDokker.js 0.0.1\nhttp://dokker.oceanhouse21.com\n(c) 2014-2015 Georg Schlenkhoff and Oceanhouse21\nDokker.js may be freely distributed under the MIT license.\n\n \n\n'use strict';\n \n \n - \n \n \n\n \n\n ¶\n\n
Define required dependencies
\n\n\n \nvar Promise = require('promise');\nvar fs = require('fs');\nvar path = require('path');\nvar read = Promise.denodeify(fs.readFile);\nvar write = Promise.denodeify(fs.writeFile);\nvar docco = require('docco');\nvar docdown = require('docdown');\nvar marked = require('marked');\nvar ejs = require('ejs');\nvar cheerio = require('cheerio');\nvar exec = require('child_process').exec;\nvar Dokker = {};\nDokker.VERSION = '0.1.2';
\n \n \n - \n \n \n\n \n\n ¶\n\n
Transclude in a ejs template file the HTML snippet that was ultimately\ncreated with docdown. Also tweak the HTML page a bit and finally\ninject the README.md.
\n\n\n \nDokker.injectTemplate = function(options) {\n return new Promise(function(resolve, reject) {\n var template, body, html, readme, $;\n return read(options.template, 'utf8')\n .then(function(data) {\n template = data;\n return read(options.readme, 'utf8');\n }).then(function(data) {\n readme = marked(data);\n $ = cheerio.load(readme);\n $('h1').remove();\n readme = $.html();\n return read(options.html, 'utf8');\n }).then(function(data) {\n $ = cheerio.load(data);\n return ejs.render(template, {\n apiToc: $('.toc-container').html(),\n readme: readme,\n apiDoc: $('.doc-container').html(),
\n \n \n - \n \n \n\n \n\n ¶\n\n
correctly setting links to your github/pages
\n\n\n \npage_url: options.site,\n title: options.title,\n github_url: options.github,
\n \n \n - \n \n \n\n \n\n ¶\n\n
fixed reference to generated annotation\nthe ‘literate’ in .dokker.json shall not require a source since it’s never used.
\n\n\n \nannotated_path: 'annotated/'+options.source\n });\n }).then(function(data) {\n return write(options.html, data, 'utf8');\n }).then(function() {\n resolve();\n }).then(null, function(err) {\n reject(err);\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Create a HTML site from any mocha tests find when executing mocha\n—reporter doc terminal command.
\n\n\n \nDokker.createTests = function(options) {\n return new Promise(function(resolve, reject) {\n var template, tests;
\n \n \n - \n \n \n\n \n\n ¶\n\n
allows specification of mocha.command in .dokker.json, e.g. ‘mocha -u tdd —reporter doc’
\n\n\n \nvar cmd = options.command || 'mocha --reporter doc';\n exec(cmd, {cwd: process.cwd()}, function(error, stdout) {\n if(error) return reject(error);\n tests = stdout;\n return read(options.template, 'utf8')\n .then(function(data) {\n template = data;\n return ejs.render(template, {tests: tests});\n }).then(function(data) {\n return write(options.path, data, 'utf8');\n }).then(function() {\n resolve();\n }).then(null, function(err) {\n reject(err);\n });\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Extract docs folder to separate git branch and finally push branch to\nGithub repository
\n\n\n \nDokker.ghPages = function(){\n return new Promise(function(resolve, reject) {\n exec('git subtree split -P docs -b gh-pages', function(error, stdout, stderr) {\n if(error) return reject(stderr);\n exec('git push origin gh-pages', function(error, stdout, stderr) {\n if(error) return reject(stderr);\n resolve();\n });\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Create an HTML file from any source code comments in the style of\nliterate programming
\n\n\n \nDokker.literate = function (options) {\n return new Promise(function(resolve, reject) {\n var tmpDir = path.join(process.cwd(), '/.tmp');\n var tmpFile = path.join(tmpDir, options.source);\n var sourceFile = (options.cwd) ?\n path.join(process.cwd(), options.cwd, options.source) :\n path.join(process.cwd(), options.source);\n return read(sourceFile, 'utf8')\n .then(function(data) {\n var source = data.replace(/^\\s*(\\*|\\/\\*).*[\\r\\n]/gm, '');\n return Dokker.mkdir(tmpDir)\n .then(function() {\n return write(tmpFile, source, 'utf8');\n }).then(function(){\n docco.run(['', '', tmpFile, '-o', options.dir]);\n resolve();\n });\n }).then(null, function(err) {\n if (err) return reject(err);\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Convert markdown from any source code comments with docdown module.
\n\n\n \nDokker.jsdocMarkdown = function (options) {\n return new Promise(function(resolve, reject) {\n var source, tmpFile, tmpDir;\n var sourceFile = (options.cwd) ?\n path.join(process.cwd(), options.cwd, options.source) :\n path.join(process.cwd(), options.source);\n return read(sourceFile, 'utf8')\n .then(function(data){\n source = data.replace(/^\\s*(\\/\\/).*[\\r\\n]/gm, '');\n tmpDir = path.join(process.cwd(), '/.tmp');\n return Dokker.mkdir(tmpDir);\n }).then(function(){\n tmpFile = path.join(tmpDir, options.source);\n return write(tmpFile, source, 'utf8');\n }).then(function(){\n var markdown = docdown({\n 'path': tmpFile,\n 'url': options.github,\n 'toc': 'categories'\n });\n return write(options.markdown, markdown, 'utf8');\n }).then(function() {\n resolve();\n }).then(null, function(err) {\n reject(err);\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Create an HTML file from any source code comments in the style of\nliterate programming
\n\n\n \nDokker.jsdocHtml = function (options) {\n return new Promise(function(resolve, reject) {\n return read(options.markdown, 'utf8')\n .then(function(data) {\n var html = marked(data).replace(/<!-- /g,'<').replace(/ -->/g,'>');\n return write(options.html, html, 'utf8');\n }).then(function() {\n resolve();\n }).then(null, function(err) {\n reject(err);\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Internal helper function that creates any directory if not existing.
\n\n\n \nDokker.mkdir = function(dir) {\n return new Promise(function(resolve, reject) {\n fs.exists(dir, function(exists) {\n if (exists) {\n resolve();\n } else {\n fs.mkdir(dir, function(err) {\n if (err) return reject(err);\n resolve();\n });\n }\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Parses the options file, .Dokker.json, and sets the default parameters.
\n\n\n \nDokker.configure = function(options) {\n return new Promise(function(resolve, reject){\n var file = path.join(process.cwd(), '.dokker.json');\n return read(file, 'utf8')\n .then(function(data) {\n data = JSON.parse(data);\n data.jsdoc.template = (data.jsdoc.template) ? path.join(process.cwd(), data.jsdoc.template) : path.join(__dirname, 'templates/index.ejs.html');\n data.mocha.template = (data.mocha.template) ? path.join(process.cwd(), data.mocha.template) : path.join(__dirname, 'templates/tests.ejs.html');\n data.mocha.path = path.join(process.cwd(), data.dir, data.mocha.path);
\n \n \n - \n \n \n\n \n\n ¶\n\n
mocha.command commented out to fix build-breaking bug\nspecifies mocha command in .dokker.json; e.g. mocha -u tdd -R spec\ndata.mocha.command = path.join(process.cwd(), data.dir, data.mocha.command);
\n\n\n \ndata.literate.dir = path.join(process.cwd(), data.dir, data.literate.dir);\n data.jsdoc.markdown = path.join(process.cwd(), data.dir, data.jsdoc.markdown);\n data.jsdoc.html = path.join(process.cwd(), data.dir, data.jsdoc.html);\n data.jsdoc.readme = path.join(process.cwd(), data.jsdoc.readme);\n resolve(data);\n }).then(null, function(err) {\n reject(err);\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Copy starter template to bootstrap any Dokker project.
\n\n\n \nDokker.copyTemplate = function(options) {\n return new Promise(function(resolve, reject) {\n var templatesDir = path.join(process.cwd(), 'templates');\n return Dokker.mkdir(templatesDir)\n .then(function() {\n var oldStyle = path.join(__dirname, 'templates', 'styles.css');\n var newStyle = path.join(process.cwd(), options.dir, 'styles.css');\n fs.createReadStream(oldStyle).pipe(fs.createWriteStream(newStyle));\n var oldLogo = path.join(__dirname, 'templates', 'logo.png');\n var newLogo = path.join(process.cwd(), options.dir, 'logo.png');\n fs.createReadStream(oldLogo).pipe(fs.createWriteStream(newLogo));\n var oldApp = path.join(__dirname, 'templates', 'app.js');\n var newApp = path.join(process.cwd(), options.dir, 'app.js');\n fs.createReadStream(oldApp).pipe(fs.createWriteStream(newApp));\n resolve();\n });\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Copies the .Dokker.json file to bootstrap any Dokker project.
\n\n\n \nDokker.init = function(){\n return new Promise(function(resolve, reject) {\n var oldDok = path.join(__dirname, '.dokker.json');\n var newDok = path.join(process.cwd(), '.dokker.json');\n fs.createReadStream(oldDok).pipe(fs.createWriteStream(newDok));\n resolve();\n });\n};
\n \n \n - \n \n \n\n \n\n ¶\n\n
Starts the Node.js/Express server to watch Dokker.js project\ndocumentation.
\n\n\n \nDokker.watch = function(options) {\n var gulpex = require(__dirname + '/gulpfile.js').gulpex;\n return gulpex();
\n \n \n - \n \n \n\n \n\n ¶\n\n
return new Promise(function(resolve, reject){ \n exec(‘DIR=’+ options.dir + ‘ node ‘ + options.dir + ‘/app.js’, function(error, stdout, stderr){\n if(error) return reject(stderr);\n });\n});
\n\n\n \n};\n\nmodule.exports = Dokker;\n \n
\n
\n
\n Dokker.js
\n - \n
- Introduction \n
- Github Repository \n
- Test suite \n
- Annotated Source \n
\n
\n
\nGithub Pages
\n- \n
Dokker.ghPages\n
\n
\n\n
\nJSDoc
\n\n\n
\n
\nLiterate programming
\n- \n
Dokker.literate\n
\n
\n\n
\nMocha
\n\n\n
\n\n
\nUtility
\n\n\n
\n
\nMethods
\n\n
\n
\n\n Properties
\n- \n
Dokker.VERSION\n
\n
\n \n\n\n"
},
{
"path": "docs/styles.css",
"content": "body,\nh1,\nh2,\nhtml,\np {\n margin: 0;\n padding: 0\n}\nhtml {\n background: #d3d3d3;\n height: 100%;\n color: #222;\n font-size: 100%\n}\nbody {\n background: #fff;\n width: 60em;\n margin: 0 auto;\n -webkit-box-shadow: 0 0 2.5em #5d656c;\n -moz-box-shadow: 0 0 2.5em #5d656c;\n box-shadow: 0 0 2.5em #5d656c;\n font: 1em/1.7'Helvetica Neue', Helvetica, Arial, sans-serif;\n min-height: 100%\n}\ncode {\n /*font-family: 'Roboto', 'Helvetica Neue', sans-serif;*/\n font-family: 'Source Code Pro', Consolas, 'Courier New', monospace;\n letter-spacing: 0.03em;\n}\n.lang-js {\n color: #78dbf9;\n}\nspan.hljs-number {\n color: #d59cf6;\n}\nspan.hljs-string{\n color: #8bdb97;\n}\nspan.hljs-regexp{\n color: #dbad83;\n}\nspan.hljs-literal{\n color: #e26a78;\n}\nspan.hljs-keyword{\n color: #d59cf6;\n}\nspan.hljs-comment {\n color: #99a4c7;\n}\nspan.hljs-special {\n color: #bdc4df;\n}\npre {\n box-shadow: 0 0 1px 1px rgba(0, 0, 0, 0.137255);\n box-shadow: 0px 0px 2px 1px rgba(0, 0, 0, 0.0980392);\n box-shadow: 0px 0px 5px 1px rgba(0, 0, 0, 0.0823529);\n border-bottom-left-radius: 5px;\n border-bottom-right-radius: 5px;\n background: #2b303b;\n margin: 1em 0;\n padding: .5em 20px;\n overflow-x: scroll;\n -webkit-overflow-scrolling: touch\n}\npre.intro {\n font-size: 1.2em\n}\npre::-webkit-scrollbar {\n height: 8px\n}\npre::-webkit-scrollbar-thumb {\n background: rgba(255, 255, 255, .8);\n -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, .5);\n -webkit-border-radius: 10px;\n border-radius: 10px\n}\npre::-webkit-scrollbar-thumb:window-inactive {\n background: rgba(255, 255, 255, .4)\n}\nh1 span,\npre {\n color: #ddd\n}\nh1,\nh2,\nh3,\nh4,\nol,\np,\nul {\n font-weight: 400;\n padding: 0 20px;\n word-wrap: break-word\n}\nhgroup h1 {\n display: inline\n}\nhgroup h2 {\n font-size: 1.38em\n}\nh2,\nh3,\nh4 {\n margin: 0 0 .5em\n}\nh4 {\n font-weight: 700\n}\na {\n color: #222;\n border-bottom: 1px solid #ddd;\n text-decoration: none\n}\na:focus,\na:hover {\n border-color: #222\n}\na img {\n border: 0\n}\nabbr[title] {\n border-bottom: 1px dotted #ddd;\n cursor: help\n}\nhr {\n display: none\n}\np {\n margin-bottom: 1em\n}\nol,\nul {\n margin-left: 2em\n}\nol ol,\nul ul {\n margin-left: 1em;\n padding: 0\n}\nfooter {\n display: block;\n background: #eee;\n padding: 1em 0;\n text-align: center\n}\n.a-img {\n border: 0\n}\n.a-img img {\n padding: .5em 0 0\n}\n.description {\n word-wrap: break-word\n}\n.multiline-items li {\n padding-bottom: 1em\n}\n.multiline-items li.last-item {\n padding-bottom: 0\n}\n.br0 {\n color: #090\n}\n.co1 {\n color: #060\n}\n.co2 {\n color: #096\n}\n.kw1,\n.kw3 {\n color: #006\n}\n.kw2 {\n color: #036\n}\n.me1 {\n color: #606\n}\n.nu0 {\n color: #c00\n}\n.st0 {\n color: #36c\n}\n.sy0 {\n color: #393;\n font-weight: 700\n}\npre .co1 {\n color: #aeaeae\n}\n.es0,\npre .st0 {\n color: #61ce3c\n}\npre .co2 {\n color: #fff\n}\npre .kw2,\npre .kw3,\npre .nu0 {\n color: #fbde2d\n}\npre .me1 {\n color: #8da6ce\n}\npre .br0,\npre .kw1,\npre .sy0 {\n color: #ddd\n}\n#docs {\n background: #fff\n}\n#docs body {\n font-size: .85em;\n width: 100%\n}\n#docs a.alias {\n opacity: .5\n}\n#docs div div div div {\n box-shadow: 0 0 1px 1px rgba(0, 0, 0, 0.137255);\n box-shadow: 0px 0px 2px 1px rgba(0, 0, 0, 0.0980392);\n box-shadow: 0px 0px 5px 1px rgba(0, 0, 0, 0.0823529);\n border-bottom-left-radius: 5px;\n border-bottom-right-radius: 5px;\n}\n#docs div div div {\n border-top: 0;\n margin: 0 .5em 1em\n}\n#docs h1,\n#docs h2,\n#docs h3,\n#docs h4,\n#docs ol,\n#docs p,\n#docs ul {\n padding: 0 10px\n}\n#docs pre {\n margin: 0;\n padding: .5em 10px\n}\n#docs ul li {\n list-style-type: none;\n margin: 0 0 0 -.9em\n}\n#docs h1 {\n padding: 0 10px\n}\n#docs h2 {\n margin: .5em 0 0\n}\n#docs h3 {\n background: rgb(63, 107, 196);\n border-radius: 3px 3px 0 0;\n border: 1px solid rgba(75, 71, 71, 0.14);\n margin: .5em 0;\n padding: .8em 0 .8em 10px;\n position: relative\n}\n#docs h3>code {\n color: #fbfbfb\n}\n#docs h3 a {\n position: absolute;\n top: 0\n}\n#docs h3 .br0 {\n color: #fc83ff\n}\n#docs h3 .kw2 {\n color: #71d0c9\n}\n#docs h3 .me1 {\n color: #fff\n}\n#docs h3 .nu0 {\n color: #d0cb71\n}\n#docs h3 .sy0 {\n color: #df74e2;\n font-weight: 700\n}\n#docs footer {\n height: 3em;\n margin-top: 1.5em;\n width: 100%\n}\n#social {\n height: 20px\n}\n#social .twitter-follow-button {\n width: 127px!important\n}\n#social .twitter-follow-button,\n.twitter-share-button {\n font-size: .8em;\n vertical-align: top\n}\n@media (max-width: 959px) {\n body {\n border: 0;\n margin: 0;\n -moz-box-shadow: none;\n -webkit-box-shadow: none;\n box-shadow: none;\n width: auto\n }\n h1,\n h2,\n h3,\n h4,\n ol,\n p,\n ul {\n padding: 0 10px\n }\n pre {\n padding: 5px 10px!important\n }\n #social {\n height: auto\n }\n .toc-container a {\n display: block;\n padding: 5px\n }\n .toc-container a:focus,\n .toc-container a:hover {\n background-color: #EEE\n }\n .toc-container a:active {\n background-color: #CCC\n }\n}\n@media (min-width: 960px) {\n #docs body {\n box-shadow: none;\n height: 100%;\n margin: 0\n }\n #docs a[href=\"#docs\"],\n #docs footer {\n display: none\n }\n #docs h1 {\n position: fixed;\n background-color: #fff;\n top: 0;\n left: 0;\n right: 0;\n z-index: 1\n }\n #docs h3 a {\n display: block;\n position: relative;\n visibility: hidden;\n top: -4em\n }\n #docs .toc-container {\n background: #fff;\n bottom: 0;\n left: 0;\n overflow-y: scroll;\n overflow-x: hidden;\n position: fixed;\n top: 1.5em;\n white-space: nowrap;\n width: 20%;\n -webkit-overflow-scrolling: touch\n }\n #docs .toc-container h2,\n #docs .toc-container ul {\n margin-top: 0;\n padding: 0 10px\n }\n #docs .doc-container {\n background: #fff;\n width: 80%;\n margin-left: 20%;\n padding-top: 1.5em\n }\n #docs .doc-container .first-heading {\n margin-top: 0\n }\n}\n@media (-ms-high-contrast: active) and (max-width: 1280px),\n(-ms-high-contrast: none) and (max-width: 1280px) {\n #docs .doc-container,\n #docs .toc-container {\n position: relative;\n top: auto;\n width: 100%\n }\n #docs .doc-container .first-heading {\n margin-top: .5em\n }\n #docs a[href=\"#docs\"] {\n display: inline\n }\n #docs footer {\n display: block\n }\n}\n@media (orientation: portrait) and (min-device-width: 720px) and (max-device-width: 768px),\n(orientation: landscape) and (device-width: 1280px) and (max-device-height: 768px) {\n @-ms-viewport{width:80%}}\n"
},
{
"path": "docs/tests.html",
"content": "\n\n \n \n \n \n
\n ![\"dokker](\"https://raw.githubusercontent.com/oceanhouse21/dokker/master/templates/logo.png\"){kind=logo}
Dokker.js creates professional Javascript code documentations.
\nSee Dokker.js documentation as example.
\n![\"Build](\"https://travis-ci.org/oceanhouse21/dokker.svg?branch=master\")
Features
\n- \n
- Create or HTML or markdown documentation from JSDOC tags \n
- Support for literate programming documentation \n
- Live edit source code and watch changes \n
- Include link to your Github repository \n
- Customize your own templates with ejs or use default style \n
- Create feature description from mocha test suite \n
- Automagically include your README.md into the documentation \n
- Use your own logo to make an astonishing impression \n
- Deploy documentation to Github pages on the fly \n
Community
\n![\"Gitter\"](\"https://badges.gitter.im/Join%20Chat.svg\")
Installation
\nDokker is available as npm package. So the easiest way is to install dokker as global module into your project:
\nnpm install -g dokker\nUsage
\nAfter installation you can execute Dokker with the help of several terminal commands.
\nBootstrap Dokker project
\nDokker needs a configuration file to execute, such as a .travis or .jshintrc. You can easily create .dokker.json file with the dokker-init command from the root directory of your project or copy an example file.
Dokker provides a default template for your project. The template is based on an ejs file. Either you use the default template or modify it. If you choose for the latter you can copy the templates directory and tweak the ejs files how you like.
\nCreate documentation
\nCreating a documentation is really simple with the help of Dokker. You just configure the .dokker.json file and execute dokker. Then you’re done.
Live edit your documentation
\nIf you want to work on your source file and see how the documentation evolves, you can do dokker-watch and it will open a browser with live preview.
Deploy to Github Pages
\nIf you want to deploy your documentation to Github Pages, run gh-pages. Finally a separate branch, named gh-pages is created from the docs folder. That is enough for Github to serve your documentation. Please do not forget to git commit your changes before your run gh-pages command.
Dokker in the wild
\nSome examples by our users. Let us know what you did with Dokker too!
\n\nFurther Reading
\n\nContributors
\n- \n
- georgschlenkhoff \n
- kengz \n
API documentation
\n \n\n
\n
\n“Github Pages” Methods
\n\n
\n\n
\n
\nDokker.ghPages()
\n\nRuns a terminal shell with the git command to extract the docs branch\ninto a seperate gh-pages branch and finally pushes that branch to Github,\nso that the Github page is updated.
\nReturns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nDokker.ghPages()\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n
\n“JSDoc” Methods
\n\n
\n\n
\n
\nDokker.injectTemplate([options])
\n\nCreates a HTML file that transcludes the HTML snippet that was created\nby the docdown module into an ejs template which is defined by the \n.dokker.json configuration file.
\nArguments
\n- \n
[options](Object): The options object. \n[options.template='template/index.ejs.html'](String): The path to the ejs template file. \n[options.html='docs/index.html'](string): The path to the docdown generated JSDoc documentation. \n[options.readme='README.md'](string): The path to the README.md file. \n[options.title=''](string): The title for the documentation. \n
Returns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nvar options = {\n template: 'template/index.ejs.html',\n html: 'docs/index.html',\n readme: 'docs/README.md',\n title: 'Dokker.js API Documentation'\n};\nDokker.injectTemplate(options)\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n\n
\n
\nDokker.jsdocHtml([options])
\n\nCreate an HTML file from the Markdown file that was create with \nDokker.jsdocMarkdown()
\nArguments
\n- \n
[options](Object): The options object. \n[options.markdown='docs/READMDE.md'](string): The path where to save the Markdown file. \n
Returns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nvar options = {\n markdown: 'docs/README.md'\n};\nDokker.jsdocHtml()\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n\n
\n
\nDokker.jsdocMarkdown([options])
\n\nCreate a Markdown file from JSDoc tags.
\nArguments
\n- \n
[options](Object): The options object. \n[options.source='app.js'](String): The path the source code with JSDoc tags. \n[options.github =''](String): The path the Github repository. \n[options.markdown='docs/READMDE.md'](string): The path where to save the Markdown file. \n
Returns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nvar options = {\n source: 'app.js',\n markdown: 'docs/README.md'\n};\nDokker.jsdocMarkdown()\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n
\n“Literate programming” Methods
\n\n
\n\n
\n
\nDokker.literate([options])
\n\nCreate a styled HTML file from your source code with the help of docco\nmodule.
\nArguments
\n- \n
[options](Object): The options object. \n[options.source='app.js'](String): The path the source code with comments \n[options.dir='docs/annotated'](string): The directory where to save the generated HTML file. \n
Returns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nvar options = {\n dir: 'docs',\n source: 'app.js'\n};\nDokker.literate()\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n
\n“Mocha” Methods
\n\n
\n\n
\n
\nDokker.createTests([options])
\n\nCreates an HTML file to describe the features of your module from your\nMocha tests. The module is using the mocha doc reporter to\ngenerate the HTML contents.
\nArguments
\n- \n
[options](Object): The options object. \n[options.path='docs.html'](String): The path where to save the HTML file \n
Returns
\n(Promise): Returns a resolved promise if file was created.
\nExample
\nvar options = {\n path: 'docs/tests.html',\n};\nDokker.createTests(options)\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n
\n“Utility” Methods
\n\n
\n\n
\n
\nDokker.configure([options])
\n\nHelper function that takes a couple of options arguments and\nnormalises them and subsequently returns them.
\nArguments
\n- \n
[options](Object): The options object. \n[options.li.markdown='docs/READMDE.md'](string): The path where to \n[options.source='app.js'](String): The path the source code with JSDoc tags. \n[options.jsdoc.markdown='docs/READMDE.md'](string): The path where to save the Markdown file. \n[options.jsdoc.README ='READMDE.md'](string): The path to the project’s README.md file \n[options.jsodc.template ='templates/index.ejs.html'](String): The path to the ejs template. \n[options.mocha.template='templates/tests.ejs.html'](String): The path to the mocha template. \n[options.dir='docs'](String): The path where to store the generated files \n
Returns
\n(Promise): Returns a resolved promise with edited options object
\nExample
\nvar options = {\n dir: 'docs',\n literate: {\n source: 'dokker.js',\n dir: 'annotated'\n },\n jsdoc: {\n title: 'Dokker.js',\n source: 'dokker.js',\n markdown: 'README.md',\n html: 'index.html',\n readme: 'README.md',\n }\n};\nDokker.jsdocHtml()\n.then(function(){\n // => object with absolute pathes to the directory from\n // which the command was executed\n});\n\n
\n
\n\n
\n
\n\n\nDokker.copyTemplate([options])
\n\nCopy the template to local directory so that one can make changes to ejs\nfiles.
\nArguments
\n- \n
[options](Object): The options object. \n[options.dir='templates'](string): The path where to save the template files \n
Returns
\n(Promise): Returns a resolved promise if files were created.
\nExample
\nvar options = {\n dir: 'template'\n};\nDokker.copyTemplate()\n.then(function(){\n // => resolved promise\n});\n\n
\n
\n
\n\n\n Methods
\nDokker
\n- \n
- creates a HTML file from annotated source code \n
return Dokker.literate(options.literate)\n.then(function(){\n done();\n}).done();\n - creates a markdown file from JSDOC comments \n
return Dokker.jsdocMarkdown(options.jsdoc)\n.then(function(){\n return read(options.jsdoc.markdown);\n}).then(function(){\n done();\n}).done();\n - creates a HTML file from JSDOC commments \n
return Dokker.jsdocHtml(options.jsdoc)\n.then(function(){\n return read(options.jsdoc.html);\n}).then(function(){\n done();\n}).done();\n - injects index.html file in ejs template \n
return Dokker.injectTemplate(options.jsdoc)\n.then(function() {\n return read(options.jsdoc.html, 'utf8');\n}).then(function(data){\n assert(/<!DOCTYPE html>/.test(data));\n done();\n}).done();\n - copies styles and app.js from template folder \n
return Dokker.copyTemplate(options)\n.then(function(){\n return read(path.join(__dirname, '..', options.dir, 'styles.css'));\n}).then(function(data){\n assert(data);\n done();\n}).done();\n
.literate()
\n- \n
.jsdocMarkdown()
\n- \ndocco: /Users/georgschlenkhoff/Downloads/dokker/.tmp/dokker.js -> /Users/georgschlenkhoff/Downloads/dokker/docs/annotated/dokker.html\n
.jsdocHtml()
\n- \n
.injectTemplate()
\n- \n
.copyTemplate()
\n- \n
\n
\n \n <%- apiToc %>\n
\n ><%= title %>
\n \n <%- apiToc %>\n \n
\n \n\n\n"
},
{
"path": "templates/styles.css",
"content": "body,\nh1,\nh2,\nhtml,\np {\n margin: 0;\n padding: 0\n}\nhtml {\n background: #d3d3d3;\n height: 100%;\n color: #222;\n font-size: 100%\n}\nbody {\n background: #fff;\n width: 60em;\n margin: 0 auto;\n -webkit-box-shadow: 0 0 2.5em #5d656c;\n -moz-box-shadow: 0 0 2.5em #5d656c;\n box-shadow: 0 0 2.5em #5d656c;\n font: 1em/1.7'Helvetica Neue', Helvetica, Arial, sans-serif;\n min-height: 100%\n}\ncode {\n /*font-family: 'Roboto', 'Helvetica Neue', sans-serif;*/\n font-family: 'Source Code Pro', Consolas, 'Courier New', monospace;\n letter-spacing: 0.03em;\n}\n.lang-js {\n color: #78dbf9;\n}\nspan.hljs-number {\n color: #d59cf6;\n}\nspan.hljs-string{\n color: #8bdb97;\n}\nspan.hljs-regexp{\n color: #dbad83;\n}\nspan.hljs-literal{\n color: #e26a78;\n}\nspan.hljs-keyword{\n color: #d59cf6;\n}\nspan.hljs-comment {\n color: #99a4c7;\n}\nspan.hljs-special {\n color: #bdc4df;\n}\npre {\n box-shadow: 0 0 1px 1px rgba(0, 0, 0, 0.137255);\n box-shadow: 0px 0px 2px 1px rgba(0, 0, 0, 0.0980392);\n box-shadow: 0px 0px 5px 1px rgba(0, 0, 0, 0.0823529);\n border-bottom-left-radius: 5px;\n border-bottom-right-radius: 5px;\n background: #2b303b;\n margin: 1em 0;\n padding: .5em 20px;\n overflow-x: scroll;\n -webkit-overflow-scrolling: touch\n}\npre.intro {\n font-size: 1.2em\n}\npre::-webkit-scrollbar {\n height: 8px\n}\npre::-webkit-scrollbar-thumb {\n background: rgba(255, 255, 255, .8);\n -webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, .5);\n -webkit-border-radius: 10px;\n border-radius: 10px\n}\npre::-webkit-scrollbar-thumb:window-inactive {\n background: rgba(255, 255, 255, .4)\n}\nh1 span,\npre {\n color: #ddd\n}\nh1,\nh2,\nh3,\nh4,\nol,\np,\nul {\n font-weight: 400;\n padding: 0 20px;\n word-wrap: break-word\n}\nhgroup h1 {\n display: inline\n}\nhgroup h2 {\n font-size: 1.38em\n}\nh2,\nh3,\nh4 {\n margin: 0 0 .5em\n}\nh4 {\n font-weight: 700\n}\na {\n color: #222;\n border-bottom: 1px solid #ddd;\n text-decoration: none\n}\na:focus,\na:hover {\n border-color: #222\n}\na img {\n border: 0\n}\nabbr[title] {\n border-bottom: 1px dotted #ddd;\n cursor: help\n}\nhr {\n display: none\n}\np {\n margin-bottom: 1em\n}\nol,\nul {\n margin-left: 2em\n}\nol ol,\nul ul {\n margin-left: 1em;\n padding: 0\n}\nfooter {\n display: block;\n background: #eee;\n padding: 1em 0;\n text-align: center\n}\n.a-img {\n border: 0\n}\n.a-img img {\n padding: .5em 0 0\n}\n.description {\n word-wrap: break-word\n}\n.multiline-items li {\n padding-bottom: 1em\n}\n.multiline-items li.last-item {\n padding-bottom: 0\n}\n.br0 {\n color: #090\n}\n.co1 {\n color: #060\n}\n.co2 {\n color: #096\n}\n.kw1,\n.kw3 {\n color: #006\n}\n.kw2 {\n color: #036\n}\n.me1 {\n color: #606\n}\n.nu0 {\n color: #c00\n}\n.st0 {\n color: #36c\n}\n.sy0 {\n color: #393;\n font-weight: 700\n}\npre .co1 {\n color: #aeaeae\n}\n.es0,\npre .st0 {\n color: #61ce3c\n}\npre .co2 {\n color: #fff\n}\npre .kw2,\npre .kw3,\npre .nu0 {\n color: #fbde2d\n}\npre .me1 {\n color: #8da6ce\n}\npre .br0,\npre .kw1,\npre .sy0 {\n color: #ddd\n}\n#docs {\n background: #fff\n}\n#docs body {\n font-size: .85em;\n width: 100%\n}\n#docs a.alias {\n opacity: .5\n}\n#docs div div div div {\n box-shadow: 0 0 1px 1px rgba(0, 0, 0, 0.137255);\n box-shadow: 0px 0px 2px 1px rgba(0, 0, 0, 0.0980392);\n box-shadow: 0px 0px 5px 1px rgba(0, 0, 0, 0.0823529);\n border-bottom-left-radius: 5px;\n border-bottom-right-radius: 5px;\n}\n#docs div div div {\n border-top: 0;\n margin: 0 .5em 1em\n}\n#docs h1,\n#docs h2,\n#docs h3,\n#docs h4,\n#docs ol,\n#docs p,\n#docs ul {\n padding: 0 10px\n}\n#docs pre {\n margin: 0;\n padding: .5em 10px\n}\n#docs ul li {\n list-style-type: none;\n margin: 0 0 0 -.9em\n}\n#docs h1 {\n padding: 0 10px\n}\n#docs h2 {\n margin: .5em 0 0\n}\n#docs h3 {\n background: rgb(63, 107, 196);\n border-radius: 3px 3px 0 0;\n border: 1px solid rgba(75, 71, 71, 0.14);\n margin: .5em 0;\n padding: .8em 0 .8em 10px;\n position: relative\n}\n#docs h3>code {\n color: #fbfbfb\n}\n#docs h3 a {\n position: absolute;\n top: 0\n}\n#docs h3 .br0 {\n color: #fc83ff\n}\n#docs h3 .kw2 {\n color: #71d0c9\n}\n#docs h3 .me1 {\n color: #fff\n}\n#docs h3 .nu0 {\n color: #d0cb71\n}\n#docs h3 .sy0 {\n color: #df74e2;\n font-weight: 700\n}\n#docs footer {\n height: 3em;\n margin-top: 1.5em;\n width: 100%\n}\n#social {\n height: 20px\n}\n#social .twitter-follow-button {\n width: 127px!important\n}\n#social .twitter-follow-button,\n.twitter-share-button {\n font-size: .8em;\n vertical-align: top\n}\n@media (max-width: 959px) {\n body {\n border: 0;\n margin: 0;\n -moz-box-shadow: none;\n -webkit-box-shadow: none;\n box-shadow: none;\n width: auto\n }\n h1,\n h2,\n h3,\n h4,\n ol,\n p,\n ul {\n padding: 0 10px\n }\n pre {\n padding: 5px 10px!important\n }\n #social {\n height: auto\n }\n .toc-container a {\n display: block;\n padding: 5px\n }\n .toc-container a:focus,\n .toc-container a:hover {\n background-color: #EEE\n }\n .toc-container a:active {\n background-color: #CCC\n }\n}\n@media (min-width: 960px) {\n #docs body {\n box-shadow: none;\n height: 100%;\n margin: 0\n }\n #docs a[href=\"#docs\"],\n #docs footer {\n display: none\n }\n #docs h1 {\n position: fixed;\n background-color: #fff;\n top: 0;\n left: 0;\n right: 0;\n z-index: 1\n }\n #docs h3 a {\n display: block;\n position: relative;\n visibility: hidden;\n top: -4em\n }\n #docs .toc-container {\n background: #fff;\n bottom: 0;\n left: 0;\n overflow-y: scroll;\n overflow-x: hidden;\n position: fixed;\n top: 1.5em;\n white-space: nowrap;\n width: 20%;\n -webkit-overflow-scrolling: touch\n }\n #docs .toc-container h2,\n #docs .toc-container ul {\n margin-top: 0;\n padding: 0 10px\n }\n #docs .doc-container {\n background: #fff;\n width: 80%;\n margin-left: 20%;\n padding-top: 1.5em\n }\n #docs .doc-container .first-heading {\n margin-top: 0\n }\n}\n@media (-ms-high-contrast: active) and (max-width: 1280px),\n(-ms-high-contrast: none) and (max-width: 1280px) {\n #docs .doc-container,\n #docs .toc-container {\n position: relative;\n top: auto;\n width: 100%\n }\n #docs .doc-container .first-heading {\n margin-top: .5em\n }\n #docs a[href=\"#docs\"] {\n display: inline\n }\n #docs footer {\n display: block\n }\n}\n@media (orientation: portrait) and (min-device-width: 720px) and (max-device-width: 768px),\n(orientation: landscape) and (device-width: 1280px) and (max-device-height: 768px) {\n @-ms-viewport{width:80%}}\n"
},
{
"path": "templates/tests.ejs.html",
"content": "\n\n \n \n \n \n <%- readme %>\n
\n