Skip to content

A sample documentation project, containing .NET source code and markdown files, can generate a static website after running docfx

License

Notifications You must be signed in to change notification settings

realrubberduckdev/docfx-seed

This branch is 3 commits ahead of docascode/docfx-seed:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

fa8e8db · Jul 22, 2021

History

67 Commits
Jul 22, 2021
Jun 2, 2016
Jul 7, 2017
May 9, 2018
Jun 12, 2017
Nov 26, 2015
Jul 18, 2016
Mar 22, 2018
May 9, 2018
Jul 22, 2021
May 9, 2018
Jun 28, 2016
May 9, 2016

Repository files navigation

docfx-seed

Build status

Description

This is a sample docfx documentation project. It contains .NET source code and markdown files. docfx.json is the configuration file for running docfx. docfx will generate a static website as similar to http://docascode.github.io/docfx-seed/index.html

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 docfx-seed\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!

About

A sample documentation project, containing .NET source code and markdown files, can generate a static website after running docfx

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 89.0%
  • Visual Basic .NET 11.0%