Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
96691f5901d8b64f248d8acdd35abd8f1ff243be
Terminal.Gui/docfx
History
Tig 96691f5901 Updated json schema
2024-09-25 18:14:16 -06:00
..
_exported_templates/modern
Apply docs changes from v2_2491-Overlapped
2024-09-19 12:37:22 -06:00
docs
Refactored Leave event and added unit tests
2024-09-21 16:01:26 -06:00
images
Fixed README, Showcase, and images
2024-07-14 07:12:04 -06:00
schemas
Updated json schema
2024-09-25 18:14:16 -06:00
aboutbox.png
Release Candiate 2 (#1248)
2021-04-26 09:31:37 -07:00
build.ps1
new docfx!
2023-12-02 19:09:37 -07:00
docfx.json
Apply docs changes from v2_2491-Overlapped
2024-09-19 12:37:22 -06:00
index.md
Apply docs changes from v2_2491-Overlapped
2024-09-19 12:37:22 -06:00
README.md
Tweaks to api docs
2023-12-03 12:16:46 -07:00
toc.yml
Tweaks to api docs
2023-12-03 12:16:46 -07:00

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

  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.