mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
dea5f0fe03
* initial * basically working * removed test settings * removed extra usings * Improved API docs * Renamed glyphs to be consistent and use unicode names; use char literals * Refactored Glyphs class & Json format to not be static (startup perf) * Refactored Glyphs class & Json format to not be static (startup perf) * Fixed a bunch of API doc errors * Switched checked/selected to glyhps from box drawing range * Switched button glyphs to nicer looking ones that seem to work on standard fonts * Upgraded LineDrawing scenario * CrossHair->Cross * Fixed unit tests * Fixed unit tests; moved Glyphs from Application to ConfigurationManager; added CM global using alias * Found and replaced all other special glyphs; fixed more unit tests
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/.
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.
If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.
Note the ./docfx/build.ps1 script will create a ./docs folder. This folder is ignored by .gitignore.