通过Dokka（Kotlin）生成文档后如何将文档发布到Github页面？

Question

我已经使用Dokka for Android 项目成功生成了 Kotlin 文档。现在我如何发布到 Github Pages。

Answer 1

使用 Github 页面操作之一。

在我的一个项目中，我使用了JamesIves/github-pages-deploy-action。这是一个例子：

name: Docs
on:
  push:
    branches: [master]
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          persist-credentials: false
      - name: Set up JDK
        uses: actions/setup-java@v1
        with:
          java-version: 11
      - name: Build documentation
        run: ./gradlew asciidoctor
      - name: Publish documentation
        uses: JamesIves/github-pages-deploy-action@releases/v3
        with:
          ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
          BRANCH: gh-pages
          FOLDER: build/docs

您需要使构建步骤适应您的构建过程，并调整生成文档的路径。

您还需要定义ACCESS_TOKEN秘密（存储库中的“设置”->“秘密”）。该令牌可以在您的个人资料设置 -> 开发人员设置 -> 个人访问令牌中生成。

还有更多操作可供选择，即https://github.com/marketplace/actions/github-pages-action，因此请进行研究并选择最适合您的操作。