jsdoc-oblivion

WebJar for jsdoc-oblivion

License	MIT
GroupId	org.webjars.npm
ArtifactId	jsdoc-oblivion
Last Version	0.0.4
Release Date	Aug 9, 2019
Type	jar
Description	jsdoc-oblivion WebJar for jsdoc-oblivion
Project URL	http://webjars.org
Source Code Management	https://github.com/miguelmota/jsdoc-oblivion

Download jsdoc-oblivion

Filename	Size
jsdoc-oblivion-0.0.4.pom
jsdoc-oblivion-0.0.4.jar	646 KB
jsdoc-oblivion-0.0.4-sources.jar	22 bytes
jsdoc-oblivion-0.0.4-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/jsdoc-oblivion/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>jsdoc-oblivion</artifactId>
    <version>0.0.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/jsdoc-oblivion/
implementation 'org.webjars.npm:jsdoc-oblivion:0.0.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/jsdoc-oblivion/
implementation ("org.webjars.npm:jsdoc-oblivion:0.0.4")

Apache Buildr

'org.webjars.npm:jsdoc-oblivion:jar:0.0.4'

Apache Ivy

<dependency org="org.webjars.npm" name="jsdoc-oblivion" rev="0.0.4">
  <artifact name="jsdoc-oblivion" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='jsdoc-oblivion', version='0.0.4')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "jsdoc-oblivion" % "0.0.4"

Leiningen

[org.webjars.npm/jsdoc-oblivion "0.0.4"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

JSDoc Oblivion Template

A gray and blue JSDoc template theme (based off docstrap).

Demo

https://lab.miguelmota.com/jsdoc-oblivion

Install

Available via npm

npm install jsdoc-oblivion

Usage

JSDoc config file jsdoc.json:

{
  "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
  }
}

Using CLI:

jsdoc src/ -r -c jsdoc.json -d docs/ -t node_modules/jsdoc-oblivion/template

Using Grunt:

npm install grunt-jsdoc --save-dev

gruntfile.js:

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');
};

Generate:

grunt jsdoc

Source

https://github.com/miguelmota/jsdoc-oblivion

License

Released under the MIT License.

Versions

Version
0.0.4 Aug 9, 2019