archiver-jsdoc-theme

Clean and minimal JSDoc 3 Template / Theme, based on Minami

Apache-2.0 28 个版本

jsdoc theme archiver

主页

仓库

提交 Issue

安装

npm install archiver-jsdoc-theme

yarn add archiver-jsdoc-theme

pnpm add archiver-jsdoc-theme

bun add archiver-jsdoc-theme

README

Minami

A clean, responsive documentation template theme for JSDoc 3.

Minami Screenshot

Uses

Install

$ npm install --save-dev minami

Usage

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", "README.md"],
        "includePattern": ".js$",
        "excludePattern": "(node_modules/|docs)"
    },
    "plugins": [
        "plugins/markdown"
    ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": true
    },
    "opts": {
        "destination": "./docs/",
        "encoding": "utf8",
        "private": true,
        "recurse": true,
        "template": "./node_modules/minami"
    }
}

License

Licensed under the Apache2 license.

版本列表

1.1.3 2020-11-19

1.1.1 2019-07-19

1.1.0 2019-04-29

1.0.24 2016-08-27

1.0.23 2016-08-27

1.0.22 2016-04-02

1.0.21 2015-12-27

1.0.20 2015-12-27

1.0.19 2015-12-27

1.0.18 2015-12-23

1.0.17 2015-12-23

1.0.16 2015-12-23

1.0.15 2015-12-23

1.0.14 2015-12-23

1.0.13 2015-12-23

1.0.12 2015-12-23

1.0.11 2015-12-23

1.0.10 2015-12-23

1.0.9 2015-12-23

1.0.8 2015-12-23

1.0.7 2015-12-23

1.0.6 2015-12-23

1.0.5 2015-12-23

1.0.4 2015-12-23

1.0.3 2015-12-23

1.0.2 2015-12-23

1.0.1 2015-12-23

1.0.0 2015-12-23