Tig Kindel
6930043911
Merge branch 'develop'
|
1 год назад | |
|---|---|---|
| .. | ||
| _exported_templates | 3 лет назад | |
| docs | 1 год назад | |
| images | 1 год назад | |
| overrides | 2 лет назад | |
| templates | 1 год назад | |
| README.md | 1 год назад | |
| aboutbox.png | 4 лет назад | |
| build.ps1 | 1 год назад | |
| docfx.json | 1 год назад | |
| index.md | 1 год назад | |
| runbuild.cmd | 3 лет назад | |
| 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. The Action publishes the docs to the gh-pages branch, which gets published to https://gui-cs.github.io/Terminal.Gui/.
NOTE: the v2 are generated from another repository (https://github.com/gui-cs/Terminal.GuiV2Docs) and are published here: https://gui-cs.github.io/Terminal.GuiV2Docs/.
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.