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

A GitHub Action to setup Docfx, to build technical documentations.

December 18, 2020 - GitHub Actions are CI/CD workflows that are integrated directly into your GitHub repository. They can be ran manually or automatically on certain events (such as push to a branch or a Pull Request being opened).

# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. concurrency: group: "pages" cancel-in-progress: false jobs: publish-docs: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Dotnet Setup uses: actions/setup-dotnet@v3 with: dotnet-version: 8.x - run: dotnet tool update -g docfx - run: docfx <docfx-project-path>/docfx.json - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: # Upload entire repository path: '<docfx-project-path>/_site' - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v4

December 20, 2021 - name: Docs Only Build on: workflow_dispatch: jobs: build-docs: name: Build Docs runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Build Documentation uses: nikeee/docfx-action@v1.0.0 with: args: docfx_project/docfx.json - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs

December 7, 2018 - Build and publish DocFX-generated documentation using a GitHub Actions workflow, with a containerized step that handles output deployment to the cloud.

A GitHub action to run DocFX and generate a documentation site. - nikeee/docfx-action

name: docfx for GitHub Pages on: # Runs on pushes targeting the default branch push: branches: - 'main' ##- 'releases/**' release: types: [published] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages permissions: contents: read pages: write id-token: write # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.

You can’t perform that action at this time.

May 30, 2026 - When you build a project, you need good technical documentation to go with it. This post walks through setting up DocFX, configuring automated API doc generation from your C# XML comments, and deploying the generated site to GitHub Pages with GitHub Actions.

October 2, 2019 - When a processing system such as docfx is used, we have to run docfx, and the resulting HTML site needs to be hosted somewhere. We can use Github Actions to do this for us.

April 11, 2022 - We will barely interact with the stable branch. When you push those changes, you can go to the Github actions and select our newly defined Docs workflow via Run workflow. After a while you can check again your GitHub page and voila you should see a familiar page. The one from DocFx and our API.

February 20, 2024 - With that in place, we run docfx to mash everything up into one deployable site. - name: zip site contents run: zip -r _site.zip docs/_site/ - name: Archive site artifacts uses: actions/upload-artifact@v3 with: name: siteArtifact path: _site.zip · We zip up and archive the site contents. This is just for reference. - name: Start deployment (PR only) if: ${{ github.ref != 'refs/heads/master'}} uses: bobheadxi/deployments@v1 id: deployment with: env: preview_${{github.event.number}} step: start token: ${{ secrets.SEAN_PAT_TO_MANAGE_ENVIRONMENTS }} This creates a new deployment environment for the PR number and creates a deployment to it with a status of started.

Demonstrates using DocFX with GitHub Actions to build and publish a documentation site for your .NET code.

GitHub Action that contains DocFX setup functionality for BUTR, used to avoid code duplication - BUTR/actions-docfx-setup

GitHub Action that contains DocFX setup functionality for BUTR, used to avoid code duplication - Actions · BUTR/actions-docfx-setup

AppMetrics / Docs.DocFx Public archive · Notifications · Fork 6 · Star 2 · Automate your workflow from idea to production · GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD.

GitHub Action for deploying a DocFX website for Unity packages to Github Pages. Report Bug ·

December 25, 2024 - Once you’ve completed the settings up to this point, Github will automatically add a Github Action called pages-build-deployment. Now, if you write code in Visual Studio, set up and build DocFX, and then push it to Github, this Action will run automatically and host the static web page.

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