Cake Addin providing docfx support
C# Shell PowerShell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Cake.DocFx
tests/Cake.DocFx.Tests
.gitattributes
.gitignore
Cake.DocFx.sln added build scripts and empty project Mar 29, 2016
LICENSE.md
README.md
ReleaseNotes.md
build.cake added build scripts and empty project Mar 29, 2016
build.ps1
build.sh

README.md

Cake.DocFx

nuget release

This Addin for the Cake Build Automation System allows you to generate a documentation website with docfx. More about Cake at http://cakebuild.net

Use the addin

To use docfx in your cake file simply import it and the docfx tool. Then define a doc task.

#addin "Cake.DocFx"
#tool "docfx.console"

Task("doc").Does(() => DocFx());

Do not forget to load '#tool "docfx.console"' at top of your cake file. Otherwise, you can not run the DocFx() command.

If the docfx.json file is anywhere else then the root directory you can pass in the location as parameter.

#addin "Cake.DocFx"
#tool "docfx.console"

Task("doc").Does(() => DocFx("./docs/docfx.json"));

INFO

The DocFx command requires an existing docfx.json file. To bootstrap docfx use docfx init or ./tools/docfx.console/tools/docfx.exe init.

Build

To build this package we are using Cake.

On Windows PowerShell run:

./build

On OSX/Linux run:

./build.sh

Run -t pack alias to create a nuget package.