https://github.com/alexhedley/docfx-test
Test GH Action to deploy docfx site
https://github.com/alexhedley/docfx-test
docfx
Last synced: about 1 year ago
JSON representation
Test GH Action to deploy docfx site
- Host: GitHub
- URL: https://github.com/alexhedley/docfx-test
- Owner: AlexHedley
- License: mit
- Created: 2020-05-19T15:30:29.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-02T09:20:55.000Z (almost 4 years ago)
- Last Synced: 2025-03-20T09:52:48.291Z (about 1 year ago)
- Topics: docfx
- Language: C#
- Homepage: https://alexhedley.github.io/docfx-test/
- Size: 560 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# docfx-seed
[](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`!