# @cara/minami 中文文档

规范地址：https://npmcn.com/package/%40cara/minami/

版本：1\.2\.3
npm 元数据更新时间：2022-04-04T21:47:17.899Z
中文译文更新时间：2026-11-09T08:51:34.868Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cara/minami
原文对照：https://npmcn.com/package/%40cara/minami/?lang=original
项目主页：https://github.com/dotnil/minami
源码仓库：https://github.com/dotnil/minami

## 关键信息（来自 npm 元数据）

- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2017-12-26T11:06:11.672Z
- 最新版本发布：2017-12-26T11:06:11.672Z
- 近 30 天下载量：3288（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

干净和最小的JSDoc 3模板/主题

## 安装

```sh
npm install @cara/minami
```

也可以使用：`pnpm add @cara/minami`、`yarn add @cara/minami`、`bun add @cara/minami`

## README

# Ami

JSDoc 3 的干净、响应的文件模板主题.

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

## 用途

-   [taffy 数据库库](http://taffydb.com/)
-   [突出模板库](http://underscorejs.org/#template)
-   [蒙特塞拉特](https://fonts.google.com/specimen/Montserrat) Helvetica 神经元( H)

## 安装

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

## 使用量

克隆寄存器到指定的 `jsdoc` 模板目录,然后:

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

### 节点.js 依赖性

在您的项目中 `package.json` 文件添加生成脚本 :

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

在你身边 `.jsdoc.json` 文件,添加模板选项.

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

### 实例 JSDoc 配置

```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"
    }
}
```

指定一个使用 Longname InNav 的编号, 它将是在 Nav( 从类开始) 中显示的最大路径元素数 .

## 许可证

持Apache2许可证.

## 常见问题

### @cara/minami 是什么？

干净和最小的JSDoc 3模板/主题

### 如何安装 @cara/minami？

在项目目录运行 npm install @cara/minami，或使用 pnpm add / yarn add / bun add。

### @cara/minami 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cara\_\_minami 是否存在。

### @cara/minami 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cara/minami 可以商用吗？

@cara/minami 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @cara/minami 的下载量有多少？

根据 npm 官方下载统计，@cara/minami 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,288 次，日均约 110 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cara/minami 还在维护吗？

最新版本 1\.2\.3 发布于 2017/12/26（8 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/12/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。