# docfx-seed

**Repository Path**: cary_hu/docfx-seed

## Basic Information

- **Project Name**: docfx-seed
- **Description**: A sample documentation project, containing .NET source code and markdown files, can generate a static website after running docfx
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-24
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docfx-seed
[![Build status](https://ci.appveyor.com/api/projects/status/psjd5g56kr0vayiw?svg=true)](https://ci.appveyor.com/project/qinezh/docfx-seed)

## 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](https://dist.nuget.org/index.html)
* Create a folder, e.g. *C:\Tools\docfx*, under the folder, `nuget install docfx.console`
* Open command line: 
```batch
set PATH=%PATH%;C:\Tools\docfx\docfx.console\tools
docfx docfx-seed\docfx.json --serve
```
#### Install from choco
* Install [chocolatey](https://chocolatey.org/install)
* Open command line:
```batch
choco install docfx
docfx docfx-seed\docfx.json --serve
```

### Cross platform
* Install [Mono](http://www.mono-project.com/download/#download-lin)
* Install [Nuget.exe](https://dist.nuget.org/index.html)
```sh
> 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](http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html) to get start. The `docfx` website itself is generated by `docfx`!