docfx-action

Note

This project is currently not actively maintained. If you've got patches, we'd be happy to accept them.

We recommend using the fork by NUnit, which fixes a lot of stuff: https://github.com/NUnit/docfx-action

A GitHub action to run DocFX and generate a documentation site.

Usage

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
    - uses: actions/checkout@v3
    # ...
    - uses: nikeee/[email protected]
      name: Build Documentation
      with:
        args: path/to/your/docfx.json

    # Publish generated site using GitHub Pages
    - uses: maxheld83/ghpages@master
      name: Publish Documentation on GitHub Pages
      env:
        BUILD_DIR: _site # docfx's default output directory is _site
        GH_PAT: ${{ secrets.GH_PAT }} # See https://github.com/maxheld83/ghpages

In general, to run docfx <something>, you can use:

    - uses: nikeee/[email protected]
      with:
        args: <something>