Skip to content

Commit 38eba1a

Browse files
committed
Update docfx README
1 parent 95119b4 commit 38eba1a

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docfx_project/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
11
# How to build docs
22

3-
Due to the lack of complete .NET 5 and C# 9.0 support (https://github.com/dotnet/docfx/issues/6790), custom fork of DocFX must be used: https://github.com/GlebChili/docfx/tree/charp-9-workaround-by-tanner-gooding. It contains workaround by [Tanner Gooding](https://github.com/tannergooding).
3+
Docs must be build with [DocFX Version 2.58](https://github.com/dotnet/docfx) or greater. DocFX version 3.x is not (yet) supported.
4+
5+
Build instructions (given that DocFX is in your `PATH`):
6+
7+
To build docs (compiled docs artifacts will be in the `_site` folder)
8+
```
9+
[Path to GmodDotNet repo]\docfx_project> docfx .\docfx.json
10+
```
11+
12+
To host a local http server and preview docs locally:
13+
```
14+
[Path to GmodDotNet repo]\docfx_project> docfx .\docfx.json --serve
15+
```

0 commit comments

Comments
 (0)