---
url: /zh/ai/codewiki.md
---
代码仓库通过配置 codewiki 相关流水线，可以自动根据仓库内容生成 wiki。此时仓库首页出现 wiki 入口，可用于快速构建文档中心。

![codewiki 入口](/images/ai/cnb-codewiki.png)

## 具体使用方法

### 步骤 1：配置流水线使用 codewiki 插件

插件镜像名字：[cnbcool/codewiki](https://cnb.cool/cnb/plugins/cnbcool/codewiki)

在代码仓库的 `.cnb.yml` 中配置 codewiki 插件。当仓库创建新的 tag 时，触发流水线。

> 注：建议使用 tag\_push 事件，避免频繁生成 wiki 文档。更多流水线事件，请参考 [构建触发规则](../build/trigger-rule.md)

```yaml title=".cnb.yml"
$:
  tag_push:
    - services:
        - docker
      docker:
        volumes:
          - /data/codewiki/${CNB_REPO_SLUG}:data
      stages:
        - name: generate codewiki
          timeout: 10h
          image: cnbcool/codewiki:latest
          settings:
            git_doc_dir: /data/codewiki/${CNB_REPO_SLUG}
```

部分插件参数说明如下，如果需要了解更多参数，请参考 [cnbcool/codewiki](https://cnb.cool/cnb/plugins/cnbcool/codewiki) 插件文档。

|参数名|说明|默认值|是否必填|备注|
|---|---|---|---|---|
|`git_doc_dir`|指定 wiki 文档生成目录|无|是|无|

### 步骤 2：使用 codewiki

在仓库首页点击 codewiki 入口，进入 codewiki 页面。