Files
Terminal.Gui/docfx
Thomas Nind 8a176a149a Fixes #3996 Update docs with new features (#3997)
* Update docs with new features

* Fix typo

* Fix another gramatical error

---------

Co-authored-by: Tig <tig@users.noreply.github.com>
2025-05-29 15:42:25 -06:00
..
2025-02-27 10:45:31 -07:00
2023-12-02 19:09:37 -07:00
2024-09-25 18:14:16 -06:00
2025-02-27 10:45:31 -07:00
2023-12-03 12:16:46 -07:00
2025-02-27 10:45:31 -07:00

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

  1. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
  2. Change to the ./docfx folder and run ./build.ps1
  3. Browse to http://localhost:8080 and verify everything looks good.
  4. Hit ctrl-c to stop the script.