# minami

> Clean and minimal JSDoc 3 Template / Theme

Latest version **1.2.3** (published 2017-04-18) · 0 weekly downloads

## Install

```sh
npm install minami
pnpm add minami
yarn add minami
bun add minami
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2017-04-18 |
| First published | 2015-03-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 577 |
| Author | Nijiko Yonskai |
| Maintainers | nijikokun |

## Links

- npm: https://www.npmjs.com/package/minami
- Repository: https://github.com/Nijikokun/minami
- Issues: https://github.com/Nijikokun/minami/issues
- npm.io page: https://npm.io/package/minami

## Recent versions

- 1.2.3 (latest) — 2017-04-18
- 1.2.2 — 2017-04-18
- 1.2.1 — 2017-04-18
- 1.2.0 — 2017-04-18
- 1.1.1 — 2015-08-10
- 1.1.0 — 2015-03-25
- 1.0.6 — 2015-03-24

## README

# Minami

A clean, responsive documentation template theme for JSDoc 3.

![Minami Screenshot](http://i.imgur.com/rPCIFqT.png)


## Uses

- [the Taffy Database library](http://taffydb.com/)
- [Underscore Template library](http://underscorejs.org/#template)
- [Montserrat](https://fonts.google.com/specimen/Montserrat) & Helvetica Neue


## Install

```bash
$ npm install --save-dev minami
```


## Usage

Clone repository to your designated `jsdoc` template directory, then:

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


### Node.js Dependency

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

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

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

```json
"opts": {
  "template": "node_modules/minami"
}
```


### Example JSDoc Config

```json
{
    "tags": {
        "allowUnknownTags": true,
        "dictionaries": ["jsdoc"]
    },
    "source": {
        "include": ["lib", "package.json", "README.md"],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "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).


## License

Licensed under the Apache2 license.

---
_Source: https://npm.io/package/minami · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._