dokker

<!DOCTYPE html> <html lang="en" id="docs"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta name="author" content="Dokker.js"> <meta name="description" content="This API documentation is built with Dokker.js at dokkerjs.com"> <title>Dokker.js</title> <link href='http://fonts.googleapis.com/css?family=Source+Code+Pro' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="styles.css" media="all"> <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/styles/default.min.css"> </head> <body> <div class="toc-container"> <h2><code><a href=http://dokkerjs.com>Dokker.js</a></code></h2> <ul> <li><a href="#">Introduction</a></li> <li><a href=https://github.com/oceanhouse21/dokker/blob/master/dokker.js>Github Repository</a></li> <li><a href="tests.html">Test suite</a></li> <li><a href=annotated/dokker.js>Annotated Source</a></li> </ul> <div> <h2 id="-github-pages-"><code>Github Pages</code></h2> <ul> <li><a href="#Dokker-ghPages"><code>Dokker.ghPages</code></a></li> </ul> </div> <div> <h2 id="-jsdoc-"><code>JSDoc</code></h2> <ul> <li><a href="#Dokker-injectTemplate"><code>Dokker.injectTemplate</code></a></li> <li><a href="#Dokker-jsdocHtml"><code>Dokker.jsdocHtml</code></a></li> <li><a href="#Dokker-jsdocMarkdown"><code>Dokker.jsdocMarkdown</code></a></li> </ul> </div> <div> <h2 id="-literate-programming-"><code>Literate programming</code></h2> <ul> <li><a href="#Dokker-literate"><code>Dokker.literate</code></a></li> </ul> </div> <div> <h2 id="-mocha-"><code>Mocha</code></h2> <ul> <li><a href="#Dokker-createTests"><code>Dokker.createTests</code></a></li> </ul> </div> <div> <h2 id="-utility-"><code>Utility</code></h2> <ul> <li><a href="#Dokker-configure"><code>Dokker.configure</code></a></li> <li><a href="#Dokker-copyTemplate"><code>Dokker.copyTemplate</code></a></li> <li><a href="#Dokker-init"><code>Dokker.init</code></a></li> <li><a href="#Dokker-watch"><code>Dokker.watch</code></a></li> </ul> </div> <div> <h2 id="-properties-"><code>Properties</code></h2> <ul> <li><a href="#Dokker-VERSION"><code>Dokker.VERSION</code></a></li> </ul> </div> </div> <div class="doc-container"> <div> <p><img src="https://raw.githubusercontent.com/oceanhouse21/dokker/master/templates/logo.png" alt="dokker logo"></p> <p>Dokker.js creates professional Javascript code documentations.</p> <p><a href="http://dokkerjs.com">See Dokker.js documentation as example.</a></p> <p><a href="https://travis-ci.org/oceanhouse21/dokker"><img src="https://travis-ci.org/oceanhouse21/dokker.svg?branch=master" alt="Build Status"></a></p> <h2 id="features">Features</h2> <ul> <li>Create or <a href="http://dokkerjs.com/">HTML</a> or <a href="https://github.com/oceanhouse21/dokker/tree/master/docs#dokkerjs-api-documentation">markdown</a> documentation from <a href="http://usejsdoc.org/">JSDOC</a> tags</li> <li>Support for <a href="https://en.wikipedia.org/?title=Literate_programming">literate programming</a> documentation</li> <li>Live edit source code and watch changes</li> <li>Include link to your Github repository</li> <li>Customize your own templates with <a href="http://www.embeddedjs.com/">ejs</a> or use default style</li> <li>Create feature description from <a href="http://mochajs.org/">mocha test suite</a></li> <li>Automagically include your README.md into the documentation</li> <li>Use your own logo to make an astonishing impression</li> <li>Deploy documentation to Github pages on the fly</li> </ul> <h2 id="community">Community</h2> <p><a href="https://gitter.im/oceanhouse21/dokker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a></p> <h2 id="installation">Installation</h2> <p>Dokker is available as npm package. So the easiest way is to install dokker as local module into your project:</p> <pre><code>npm install dokker </code></pre><h2 id="usage">Usage</h2> <p>After installation you can execute Dokker with the help of several terminal commands.</p> <p><strong>Bootstrap Dokker project</strong></p> <p>Dokker needs a configuration file to execute, such as a <a href="https://travis-ci.org/">.travis</a> or <a href="http://jshint.com/docs/">.jshintrc</a>. You can easily create .dokker.json file with the <code>./node_modules/dokker/bin/init</code> command from the root directory of your project or copy an <a href="https://github.com/oceanhouse21/dokker/blob/master/.dokker.json">example file</a>.</p> <p>Dokker provides a default template for your project. The template is based on an <a href="http://www.embeddedjs.com/">ejs</a> file. Either you use the default template or modify it. If you choose for the latter you can copy the <a href="https://github.com/oceanhouse21/dokker/tree/master/templates">templates directory</a> and tweak the ejs files how you like.</p> <p><strong>Create documentation</strong></p> <p>Creating a documentation is really simple with the help of Dokker. You just configure the <a href="https://github.com/oceanhouse21/dokker/blob/master/.dokker.json">.dokker.json</a> file and execute <code>./node_modules/dokker/bin/dokker</code>. Then you’re done.</p> <p><strong>Live edit your documentation</strong></p> <p>If you want to work on your source file and see how the documentation evolves, you can do <code>./node_modules/dokker/bin/watch</code> and it will open a browser with live preview.</p>  <p><strong>Deploy to Github Pages</strong></p> <p>If you want to deploy your documentation to Github Pages, run <code>./node_modules/dokker/bin/gh-pages</code>. Finally a separate branch, named <code>gh-pages</code> is created from the <code>docs</code> folder. That is enough for Github to serve your documentation. Please do not forget to <code>git commit</code> your changes before your run <code>gh-pages</code> command.</p> <h2 id="dokker-in-the-wild">Dokker in the wild</h2> <p>Some examples by our users. Let us know what you did with Dokker too!</p> <ul> <li><a href="http://dokkerjs.com">Dokker.js</a></li> <li><a href="http://kengz.github.io/lomath/">lomath</a></li> </ul> <h2 id="further-reading">Further Reading</h2> <ul> <li><a href="http://dokkerjs.com">API Documentation</a></li> <li><a href="https://github.com/oceanhouse21/dokker/wiki/Changelog">Changelog</a></li> <li><a href="https://github.com/oceanhouse21/dokker/releases">Release Notes</a></li> <li><a href="https://github.com/oceanhouse21/dokker/wiki/Roadmap">Roadmap</a></li> <li><a href="https://github.com/oceanhouse21/dokker/wiki/Resources">More Resources</a></li> </ul> <h2 id="contributors">Contributors</h2> <ul> <li><a href="https://github.com/georgschlenkhoff">georgschlenkhoff</a></li> <li><a href="https://github.com/kengz">kengz</a></li> </ul> <h2>API documentation</h2> <div> <h2 id="-github-pages-methods-"><code>“Github Pages” Methods</code></h2> <div> <h3 id="-a-id-dokker-ghpages-a-dokker-ghpages-"><a id="Dokker-ghPages"></a><code>Dokker.ghPages()</code></h3> <p><a href="#Dokker-ghPages">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L152" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Runs a terminal shell with the git command to extract the docs branch into a seperate gh-pages branch and finally pushes that branch to Github, so that the Github page is updated.</p> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js">Dokker.ghPages() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> </div> <div> <h2 id="-jsdoc-methods-"><code>“JSDoc” Methods</code></h2> <div> <h3 id="-a-id-dokker-injecttemplate-a-dokker-injecttemplate-options-"><a id="Dokker-injectTemplate"></a><code>Dokker.injectTemplate([options])</code></h3> <p><a href="#Dokker-injectTemplate">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L56" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Creates a HTML file that transcludes the HTML snippet that was created by the docdown module into an ejs template which is defined by the .dokker.json configuration file.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.template='template/index.ejs.html']</code> <em>(String)</em>: The path to the ejs template file.</li> <li><code>[options.html='docs/index.html']</code> <em>(string)</em>: The path to the docdown generated JSDoc documentation.</li> <li><code>[options.readme='README.md']</code> <em>(string)</em>: The path to the README.md file.</li> <li><code>[options.title='']</code> <em>(string)</em>: The title for the documentation.</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { template: <span class="hljs-string">'template/index.ejs.html'</span>, html: <span class="hljs-string">'docs/index.html'</span>, readme: <span class="hljs-string">'docs/README.md'</span>, title: <span class="hljs-string">'Dokker.js API Documentation'</span> }; Dokker.injectTemplate(options) .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> <div> <h3 id="-a-id-dokker-jsdochtml-a-dokker-jsdochtml-options-"><a id="Dokker-jsdocHtml"></a><code>Dokker.jsdocHtml([options])</code></h3> <p><a href="#Dokker-jsdocHtml">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L282" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Create an HTML file from the Markdown file that was create with <a href="#Dokker-jsdocMarkdown">Dokker.jsdocMarkdown()</a></p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.markdown='docs/READMDE.md']</code> <em>(string)</em>: The path where to save the Markdown file.</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { markdown: <span class="hljs-string">'docs/README.md'</span> }; Dokker.jsdocHtml() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> <div> <h3 id="-a-id-dokker-jsdocmarkdown-a-dokker-jsdocmarkdown-options-"><a id="Dokker-jsdocMarkdown"></a><code>Dokker.jsdocMarkdown([options])</code></h3> <p><a href="#Dokker-jsdocMarkdown">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L234" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Create a Markdown file from JSDoc tags.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.source='app.js']</code> <em>(String)</em>: The path the source code with JSDoc tags.</li> <li><code>[options.github ='']</code> <em>(String)</em>: The path the Github repository.</li> <li><code>[options.markdown='docs/READMDE.md']</code> <em>(string)</em>: The path where to save the Markdown file.</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { source: <span class="hljs-string">'app.js'</span>, markdown: <span class="hljs-string">'docs/README.md'</span> }; Dokker.jsdocMarkdown() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> </div> <div> <h2 id="-literate-programming-methods-"><code>“Literate programming” Methods</code></h2> <div> <h3 id="-a-id-dokker-literate-a-dokker-literate-options-"><a id="Dokker-literate"></a><code>Dokker.literate([options])</code></h3> <p><a href="#Dokker-literate">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L189" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Create a styled HTML file from your source code with the help of <strong>docco</strong> module.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.source='app.js']</code> <em>(String)</em>: The path the source code with comments</li> <li><code>[options.dir='docs/annotated']</code> <em>(string)</em>: The directory where to save the generated HTML file.</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { dir: <span class="hljs-string">'docs'</span>, source: <span class="hljs-string">'app.js'</span> }; Dokker.literate() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> </div> <div> <h2 id="-mocha-methods-"><code>“Mocha” Methods</code></h2> <div> <h3 id="-a-id-dokker-createtests-a-dokker-createtests-options-"><a id="Dokker-createTests"></a><code>Dokker.createTests([options])</code></h3> <p><a href="#Dokker-createTests">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L113" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Creates an HTML file to describe the features of your module from your <strong>Mocha</strong> tests. The module is using the mocha <strong>doc</strong> reporter to generate the HTML contents.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.path='docs.html']</code> <em>(String)</em>: The path where to save the HTML file</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if file was created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { path: <span class="hljs-string">'docs/tests.html'</span>, }; Dokker.createTests(options) .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> </div> <div> <h2 id="-utility-methods-"><code>“Utility” Methods</code></h2> <div> <h3 id="-a-id-dokker-configure-a-dokker-configure-options-"><a id="Dokker-configure"></a><code>Dokker.configure([options])</code></h3> <p><a href="#Dokker-configure">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L355" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Helper function that takes a couple of options arguments and normalises them and subsequently returns them.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.li.markdown='docs/READMDE.md']</code> <em>(string)</em>: The path where to</li> <li><code>[options.source='app.js']</code> <em>(String)</em>: The path the source code with JSDoc tags.</li> <li><code>[options.jsdoc.markdown='docs/READMDE.md']</code> <em>(string)</em>: The path where to save the Markdown file.</li> <li><code>[options.jsdoc.README ='READMDE.md']</code> <em>(string)</em>: The path to the project’s README.md file</li> <li><code>[options.jsodc.template ='templates/index.ejs.html']</code> <em>(String)</em>: The path to the ejs template.</li> <li><code>[options.mocha.template='templates/tests.ejs.html']</code> <em>(String)</em>: The path to the mocha template.</li> <li><code>[options.dir='docs']</code> <em>(String)</em>: The path where to store the generated files</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise with edited options object</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { dir: <span class="hljs-string">'docs'</span>, literate: { source: <span class="hljs-string">'dokker.js'</span>, dir: <span class="hljs-string">'annotated'</span> }, jsdoc: { title: <span class="hljs-string">'Dokker.js'</span>, source: <span class="hljs-string">'dokker.js'</span>, markdown: <span class="hljs-string">'README.md'</span>, html: <span class="hljs-string">'index.html'</span>, readme: <span class="hljs-string">'README.md'</span>, } }; Dokker.jsdocHtml() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => object with absolute pathes to the directory from</span> <span class="hljs-comment">// which the command was executed</span> }); </code></pre> <hr> </div> <div> <h3 id="-a-id-dokker-copytemplate-a-dokker-copytemplate-options-"><a id="Dokker-copyTemplate"></a><code>Dokker.copyTemplate([options])</code></h3> <p><a href="#Dokker-copyTemplate">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L397" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Copy the template to local directory so that one can make changes to ejs files.</p> <h4 id="arguments">Arguments</h4> <ol> <li><code>[options]</code> <em>(Object)</em>: The options object.</li> <li><code>[options.dir='templates']</code> <em>(string)</em>: The path where to save the template files</li> </ol> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if files were created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js"><span class="hljs-keyword">var</span> options = { dir: <span class="hljs-string">'template'</span> }; Dokker.copyTemplate() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> <div> <h3 id="-a-id-dokker-init-a-dokker-init-"><a id="Dokker-init"></a><code>Dokker.init()</code></h3> <p><a href="#Dokker-init">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L431" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Create a .dokker.json file to bootstrap any Dokker project</p> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if files were created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js">Dokker.init() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> <div> <h3 id="-a-id-dokker-watch-a-dokker-watch-"><a id="Dokker-watch"></a><code>Dokker.watch()</code></h3> <p><a href="#Dokker-watch">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L456" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>Starts a Node.js/Express webserver in docs directory to watch the build Dokker project</p> <h4 id="returns">Returns</h4> <p><em>(Promise)</em>: Returns a resolved promise if files were created.</p> <h4 id="example">Example</h4> <pre><code class="lang-js">Dokker.init() .then(<span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)</span>{ <span class="hljs-comment">// => resolved promise</span> }); </code></pre> <hr> </div> </div> <div> <h2 id="-properties-"><code>Properties</code></h2> <div> <h3 id="-a-id-dokker-version-a-dokker-version-"><a id="Dokker-VERSION"></a><code>Dokker.VERSION</code></h3> <p><a href="#Dokker-VERSION">#</a> <a href="https://github.com/oceanhouse21/dokker/blob/master/dokker.js#L23" title="View in source">Ⓢ</a> [Ⓣ][1]</p> <p>(string): The semantic version number.</p> <hr> </div> </div> </div> </div> <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/8.6/highlight.min.js"></script> </body> </html>