Tig
c537c347ee
doc tweak
|
1 سال پیش | |
|---|---|---|
| .. | ||
| _exported_templates | 3 سال پیش | |
| docs | 1 سال پیش | |
| images | 1 سال پیش | |
| schemas | 1 سال پیش | |
| templates | 1 سال پیش | |
| README.md | 1 سال پیش | |
| aboutbox.png | 4 سال پیش | |
| build.ps1 | 1 سال پیش | |
| docfx.json | 1 سال پیش | |
| index.md | 1 سال پیش | |
| toc.yml | 1 سال پیش | |
README.md
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.
To Generate the Docs Locally
- Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
- Change to the
./docfxfolder and run./build.ps1 - Browse to http://localhost:8080 and verify everything looks good.
- Hit ctrl-c to stop the script.