Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docascode/docfx-seed

A sample documentation project, containing .NET source code and markdown files, can generate a static website after running docfx
https://github.com/docascode/docfx-seed

Last synced: 8 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/docascode/docfx-seed
Owner: docascode
License: mit
Archived: true
Created: 2015-11-26T05:30:44.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2021-10-11T06:16:23.000Z (about 3 years ago)
Last Synced: 2024-08-01T19:42:05.469Z (4 months ago)
Language: C#
Homepage: http://docascode.github.io/docfx-seed/index.html
Size: 935 KB
Stars: 130
Watchers: 16
Forks: 185
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

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`!