Git Product home page Git Product logo

docfx-build-action's Introduction

DocFx Build Action

A GitHub Action to build Docfx documentation.

Usage

Prerequisites:

Action

  • docfx-file-path (optional): Specify this input if your docfx.json is not in the working directory.
  • docfx-output-path (optional): Defaults to _site in the folder where the docfx.json file is located.
- name: Build Documentation
  uses: clFaster/docfx-build-action@v1
  with:
    docfx-file-path: "docs/docfx.json"
    docfx-output-path: "output-path"

Example Workflow

A complete example of a workflow that builds Docfx documentation.

- name: Checkout
  uses: actions/checkout@v4

- name: Setup .NET Core 8.x
  uses: actions/setup-dotnet@v3
  with:
    dotnet-version: "8.x"

- name: Setup DocFx
  uses: clFaster/docfx-setup-action@v1

- name: Build Documentation
  uses: clFaster/docfx-build-action@v1
  with:
    docfx-file-path: "docs/docfx.json"

docfx-build-action's People

Contributors

clfaster avatar

Stargazers

avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.