Code Wiki

242 字小于 1 分钟

通过配置 codewiki 流水线，可自动根据仓库代码生成 Wiki 文档，仓库首页将出现 Wiki 入口，便于快速构建文档中心。

使用方法

步骤 1：配置流水线

在仓库的 .cnb.yml 中配置 codewiki 插件。建议使用 tag_push 事件触发，避免频繁生成 Wiki。更多事件类型请参考构建触发规则。

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

主要参数说明：

参数名	说明	默认值	是否必填
`git_doc_dir`	Wiki 文档生成目录	无	是

更多参数请参阅 cnbcool/codewiki 插件文档。

步骤 2：访问 CodeWiki

在仓库首页点击 Wiki 入口，即可进入 CodeWiki 页面。