hungluu / namis

Clean and minimal JSDoc 3 Template / Theme

Namis

A clean, responsive documentation template theme for JSDoc 3, based on Minami

Uses

• the Taffy Database library
• Underscore Template library
• Montserrat & Helvetica Neue

Live examples

• Honeyjs Document

What's new

• Implements a search engine
• Makes a more themeable template based on Minami, all you need to do is edit the custom.css file
• Uses more attractive jQuery scroll plugin named NiceScroll
• Improves color scheme and UI

Install

$ npm install --save-dev namis

Usage

Clone repository to your designated jsdoc template directory, then:

$ jsdoc entry-file.js -t path/to/namis

Node.js Dependency

In your projects package.json file add a generate script:

"script": {
  "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
}

In your .jsdoc.json file, add a template option.

"opts": {
  "template": "node_modules/mamis"
}

Example JSDoc Config

Example can be found on root folder of this package named jsdoc.json:

{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc", "closure"]
    },
    "source": {
        "include": [".", "README.md", "package.json"],
        "includePattern": "test.js$",
        "excludePattern": "docs"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": true,
        "monospaceLinks": true,
        "systemName": "remoteFileExplorer",
        "copyright": "2015",
        "linenums": true,
        "collapseSymbols": true
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": false,
        "recurse": true,
        "template": "./node_modules/namis"
    }
}

License

Licensed under the Apache2 license.

Contribution

Here is some simple steps

1. Fork, then clone the repo at [email protected]:your-username/namis.git

2. Push to your fork and submit a pull request

3. Write a good commit message

Enjoy.