Skip to content

Latest commit

 

History

History
33 lines (29 loc) · 1.16 KB

README.md

File metadata and controls

33 lines (29 loc) · 1.16 KB
Raw

SOFTINUX Base Documentation

Description

This is the repository to make api documentation for SOFTINUX Base.

How to run

Under Windows

Install from Nuget

  • Install Nuget.exe
  • Create a folder, e.g. C:\Tools\docfx, under the folder, nuget install docfx.console
  • Open command line:
set PATH=%PATH%;C:\Tools\docfx\docfx.console\tools
docfx Softinux_Base_Api\docfx.json --serve

Install from choco

choco install docfx
docfx docfx-seed\docfx.json --serve

Cross platform

> mono nuget.exe install docfx.console
> mono docfx.console/tools/docfx.exe docfx-seed/docfx.json

Further information about docfx

docfx is a tool to generate documentation towards .NET source code and markdown files. Please refer to docfx to get start. The docfx website itself is generated by docfx!