https://github.com/cake-contrib/cake.docfx

Cake Addin providing DocFx support
https://github.com/cake-contrib/cake.docfx

cake-addin cake-build docfx hacktoberfest

Last synced: 5 days ago
JSON representation

Cake Addin providing DocFx support

• Host: GitHub
• URL: https://github.com/cake-contrib/cake.docfx
• Owner: cake-contrib
• License: mit
• Created: 2016-03-30T09:22:54.000Z (about 9 years ago)
• Default Branch: develop
• Last Pushed: 2022-05-26T18:31:28.000Z (almost 3 years ago)
• Last Synced: 2025-04-16T01:49:49.714Z (13 days ago)
• Topics: cake-addin, cake-build, docfx, hacktoberfest
• Language: C#
• Homepage: https://cake-contrib.github.io/Cake.DocFx
• Size: 2.04 MB
• Stars: 15
• Watchers: 7
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Cake.DocFx Addin

This Addin for the Cake Build Automation System allows you to generate a documentation website with [docfx](http://dotnet.github.io/docfx/index.html). More about Cake at [cakebuild.net](http://cakebuild.net).

[![License](http://img.shields.io/:license-mit-blue.svg)](http://cake-contrib.mit-license.org)

## Information

| |Stable|Pre-release|

|:--:|:--:|:--:|

|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.DocFx.svg)](https://github.com/cake-contrib/Cake.DocFx/releases/latest)|

|NuGet|[![NuGet](https://img.shields.io/nuget/v/Cake.DocFx.svg)](https://www.nuget.org/packages/Cake.DocFx)|[![NuGet](https://img.shields.io/nuget/vpre/Cake.DocFx.svg)](https://www.nuget.org/packages/Cake.DocFx)|

## Build Status

|Develop|Master|

|:--:|:--:|

|[![Build status](https://ci.appveyor.com/api/projects/status/clgjyeqo4n0j232i/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-docfx/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/clgjyeqo4n0j232i/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-docfx/branch/master)|

## Code Coverage

[![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.DocFx/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.DocFx?branch=develop)

## Quick Links

- [Documentation](https://cake-contrib.github.io/Cake.DocFx)

## Discussion

For questions and to discuss ideas & feature requests, use the [GitHub discussions on the Cake GitHub repository](https://github.com/cake-build/cake/discussions), under the [Extension Q&A](https://github.com/cake-build/cake/discussions/categories/extension-q-a) category.

[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)

## Build

To build this package we are using Cake.

On Windows PowerShell run:

```powershell

./build

```

On OSX/Linux run:

```bash

./build.sh

```