Minami 使用与配置教程

Minami 使用与配置教程

minami 💅 Clean and minimal JSDoc 3 Template / Theme 项目地址: https://gitcode.com/gh_mirrors/mi/minami

1. 项目目录结构及介绍

Minami 是一个为 JSDoc 3 设计的简洁、响应式文档模板主题。项目的主要目录结构如下：

minami/
├── .gitignore          # Git 忽略文件
├── LICENSE             # 项目许可证文件
├── README.md           # 项目自述文件
├── publish.js          # 发布脚本文件
├── static/             # 静态文件目录
│   ├── css/            # CSS 文件目录
│   ├── fonts/          # 字体文件目录
│   └── js/             # JavaScript 文件目录
└── tmpl/               # 模板文件目录
    ├── bss.jst         # 模板文件
    ├── footer.jst      # 页脚模板文件
    ├── header.jst      # 头部模板文件
    ├── index.jst       # 主页模板文件
    └── tutorials.jst   # 教程模板文件

• .gitignore：指定 Git 忽略跟踪的文件和目录。
• LICENSE：Apache 2.0 许可证文件，说明项目的版权和授权信息。
• README.md：项目自述文件，介绍项目信息、安装和配置方法。
• publish.js：发布脚本，用于处理文档生成过程中的特定任务。
• static/：包含项目所需的静态资源，如 CSS 样式表、字体文件和 JavaScript 脚本。
• tmpl/：包含 JSDoc 生成文档所需的模板文件。

2. 项目的启动文件介绍

Minami 项目中没有直接的启动文件，因为它是作为 JSDoc 的模板主题使用的。要使用这个主题，你需要先安装 JSDoc 并配置你的项目以使用 Minami。

在项目的根目录中，运行以下命令安装 Minami：

npm install --save-dev minami

然后，在执行 JSDoc 命令时指定 Minami 作为模板：

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

3. 项目的配置文件介绍

要配置 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"
  }
}

在这个配置文件中，你可以设置文档的生成路径、编码、是否包含私有成员、是否递归扫描文件以及使用的模板路径等选项。确保 template 选项设置为 Minami 的路径，以便 JSDoc 使用这个主题来生成文档。

minami 💅 Clean and minimal JSDoc 3 Template / Theme 项目地址: https://gitcode.com/gh_mirrors/mi/minami