wagesj45/CapyKit
wagesj45/CapyKit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Improve DocFX documentation generation

Browse source
This commit is contained in:
Jordan Wages 2026-07-07 13:52:41 -05:00
commit 9ce4e18637
316 changed files with 476 additions and 23671 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Docs/index.md
View file

@ -12,7 +12,7 @@ The library targets .NET 8 and keeps its public surface intentionally direct. Mo
- [Introduction](introduction.md) explains what CapyKit includes and how the namespaces are organized.
- [Getting Started](getting-started.md) shows installation, imports, and common usage examples.
- [API Reference](api/CapyKit.md) contains the generated DocFX reference for every public type and member.
- [API Reference](api/CapyKit.yml) contains the generated DocFX reference for every public type and member.
## Common Tasks
@ -72,8 +72,8 @@ CapyEventReporter.Subscribe(
The documentation is generated with DocFX from the Markdown files in this folder and the XML comments in the `CapyKit` project.
```bash
dotnet tool install -g docfx
docfx Docs/docfx.json --serve
dotnet tool restore
dotnet docfx Docs/docfx.json --serve
```
DocFX writes the generated site to `Docs/_site`.