mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
11 lines
471 B
Markdown
11 lines
471 B
Markdown
This folder generates the API docs for Terminal.Gui.
|
|
|
|
The API documentation is generated via a GitHub Action (`.github/workflows/api-docs.yml`) using [DocFX](https://github.com/dotnet/docfx).
|
|
|
|
## To Generate the Docs Locally
|
|
|
|
0. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
|
|
1. Change to the `./docfx` folder and run `./build.ps1`
|
|
2. Browse to http://localhost:8080 and verify everything looks good.
|
|
3. Hit ctrl-c to stop the script.
|