This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Generate Markdown Documentation | |
| on: | |
| push: | |
| branches: | |
| - doc # adjust if your default branch is different | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Setup .NET SDK | |
| uses: actions/setup-dotnet@v1 | |
| with: | |
| dotnet-version: 7.0.x # adjust to the compatible .NET version for docfx | |
| - name: Install DocFx | |
| run: dotnet tool install --global docfx | |
| - name: Generate Markdown Documentation | |
| run: | | |
| export PATH="$PATH:/home/runner/.dotnet/tools" | |
| docfx docfx.json | |
| # Optional: Push Generated Documentation to Repository | |
| - name: Push Generated Documentation to Repository | |
| uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: 'Update generated markdown documentation' | |
| branch: 'docs' # change to your preference | |
| file_pattern: _site/markdown/* # or wherever your markdown docs are generated |