https://github.com/nijikokun/minami

💅 Clean and minimal JSDoc 3 Template / Theme
https://github.com/nijikokun/minami

Last synced: about 4 hours ago
JSON representation

💅 Clean and minimal JSDoc 3 Template / Theme

• Host: GitHub
• URL: https://github.com/nijikokun/minami
• Owner: nijikokun
• License: other
• Created: 2015-02-12T01:18:03.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T10:03:27.000Z (10 months ago)
• Last Synced: 2024-11-12T07:04:09.083Z (1 day ago)
• Language: JavaScript
• Homepage:
• Size: 574 KB
• Stars: 575
• Watchers: 8
• Forks: 161
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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

"scripts": {

  "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.