By configuring the CodeWiki pipeline, you can automatically generate Wiki documentation from your repository's code. A Wiki portal will appear on the repository homepage, enabling quick documentation center setup.

CodeWiki Portal

Usage

Step 1: Configure the Pipeline

Plugin image: cnbcool/codewiki

Configure the CodeWiki plugin in the repository's .cnb.yml. It is recommended to use the tag_push event to avoid frequent Wiki generation. For more event types, see Build Trigger Rules.

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

Key parameters:

Parameter Name	Description	Default Value	Required
git_doc_dir	Directory for generating Wiki documentation	None	Yes

For more information, see the cnbcool/codewiki plugin documentation.

Step 2: Access CodeWiki

Click the Wiki portal on the repository homepage to access the CodeWiki page.

Previous pageKnowledge Base