jsdoc-oblivion
Version:
A gray and blue theme for JSDoc.
348 lines (245 loc) • 9.77 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="initial-scale=1, maximum-scale=1, user-scalable=yes, width=device-width">
<title>Oblivion — Index</title>
<link rel="shortcut icon" href="/favicon.ico">
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.dark.css">
<link type="text/css" rel="stylesheet" href="styles/site.oblivion.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Oblivion</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="module-base.html">base</a>
</li>
<li>
<a href="module-base_chains.html">base/chains</a>
</li>
<li>
<a href="module-documents_binder.html">documents/binder</a>
</li>
<li>
<a href="module-documents_model.html">documents/model</a>
</li>
<li>
<a href="module-documents_probe.html">documents/probe</a>
</li>
<li>
<a href="module-documents_schema.html">documents/schema</a>
</li>
<li>
<a href="module-ink_collector.html">ink/collector</a>
</li>
<li>
<a href="module-mixins_bussable.html">mixins/bussable</a>
</li>
<li>
<a href="module-mixins_signalable.html">mixins/signalable</a>
</li>
<li>
<a href="module-strings_format.html">strings/format</a>
</li>
<li>
<a href="module-utils_logger.html">utils/logger</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="base.html">base</a>
</li>
<li>
<a href="base_chains.html">base/chains</a>
</li>
<li>
<a href="documents_model.html">documents/model</a>
</li>
<li>
<a href="module-documents_probe.queryOperators.html">documents/probe.queryOperators</a>
</li>
<li>
<a href="module-documents_probe.updateOperators.html">documents/probe.updateOperators</a>
</li>
<li>
<a href="module-ink_collector-ACollector.html">ink/collector~ACollector</a>
</li>
<li>
<a href="module-ink_collector-CollectorBase.html">ink/collector~CollectorBase</a>
</li>
<li>
<a href="module-ink_collector-OCollector.html">ink/collector~OCollector</a>
</li>
<li>
<a href="module-mixins_signalable-Signal.html">mixins/signalable~Signal</a>
</li>
<li>
<a href="utils_logger.Logger.html">utils/logger.Logger</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="mixins.list.html" class="dropdown-toggle" data-toggle="dropdown">Mixins<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="documents_schema.html">documents/schema</a>
</li>
<li>
<a href="mixins_bussable.html">mixins/bussable</a>
</li>
<li>
<a href="mixins_signalable.html">mixins/signalable</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span3">
<div id="toc"></div>
</div>
<div class="span9">
<div id="main">
<span class="page-title">Index</span>
<section class="readme-section">
<article><h1>JSDoc Oblivion Template</h1><blockquote>
<p>A gray and blue <a href="http://usejsdoc.org/">JSDoc</a> template theme (based off <a href="https://github.com/terryweiss/docstrap">docstrap</a>).</p>
</blockquote>
<h1>Demo</h1><p><strong><a href="https://lab.miguelmota.com/jsdoc-oblivion">https://lab.miguelmota.com/jsdoc-oblivion</a></strong></p>
<h1>Install</h1><p>Available via <a href="https://www.npmjs.org/">npm</a></p>
<pre class="prettyprint source lang-bash"><code>npm install jsdoc-oblivion</code></pre><h1>Usage</h1><p>JSDoc config file <code>jsdoc.json</code>:</p>
<pre class="prettyprint source lang-json"><code>{
"tags": {
"allowUnknownTags": true
},
"source": {
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": [],
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"default": {
"outputSourceFiles": true
},
"systemName" : "Oblivion",
"footer" : "",
"copyright" : "Copyright © 2014",
"navType" : "vertical",
"theme" : "oblivion",
"linenums" : true,
"collapseSymbols" : false,
"inverseNav" : true
}
}</code></pre><p><strong>Using CLI:</strong></p>
<pre class="prettyprint source"><code>jsdoc src/ -r -c jsdoc.json -d docs/ -t node_modules/jsdoc-oblivion/template</code></pre><p><strong>Using <a href="http://gruntjs.com/">Grunt</a>:</strong></p>
<pre class="prettyprint source lang-bash"><code>npm install grunt-jsdoc --save-dev</code></pre><p><code>gruntfile.js</code>:</p>
<pre class="prettyprint source lang-javascript"><code>module.exports = function (grunt) {
grunt.initConfig({
pkg: grunt.file.readJSON('package.json'),
jsdoc : {
dist : {
src: [
'./**/*.js',
'README.md'
],
jsdoc: './node_modules/.bin/jsdoc',
options: {
destination: 'docs',
configure: './jsdocjson',
template: './node_modules/jsdoc-oblivion/template'
}
}
}
});
grunt.registerTask('default', ['grunt-jsdoc']);
grunt.loadNpmTasks('grunt-jsdoc');
};</code></pre><p>Generate:</p>
<pre class="prettyprint source lang-bash"><code>grunt jsdoc</code></pre><h1>Source</h1><p><a href="https://github.com/miguelmota/jsdoc-oblivion">https://github.com/miguelmota/jsdoc-oblivion</a></p>
<h1>License</h1><p>Released under the MIT License.</p></article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Copyright © 2014 <a href='http://moogs.io' target='_blank'>Moogs, LLC.</a>
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc" target="_blank">JSDoc 3.4.3</a>
on 2017-07-16T00:18:22-07:00
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<!--<script src="scripts/sunlight.js"></script>-->
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : "100px"
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
// $( ".tutorial-section pre, .readme-section pre" ).addClass( "sunlight-highlight-javascript" ).addClass( "linenums" );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
lang = "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
</body>
</html>