Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @montacasa/minami with all npm packages installed. Try it out:

var minami = require("@montacasa/minami")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@montacasa/minami v1.2.5-rc.1

[Forked] Clean and minimal JSDoc 3 Template / Theme


A clean, responsive documentation template theme for JSDoc 3.

Minami Screenshot



$ npm install --save-dev minami


Clone repository to your designated jsdoc template directory, then:

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

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/minami"

Example JSDoc Config

    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    "source": {
        "include": ["lib", "package.json", ""],
        "includePattern": ".jsquot;,
        "excludePattern": "(node_modules/|docs)"
    "plugins": [
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true,
        "useLongnameInNav": false,
        "showInheritedInNav": true
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/minami"

Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).


Licensed under the Apache2 license.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free