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
8683568956c6ab7a2ef5432948202300dec1c4ac
Terminal.Gui/docfx
History
Tig fab361d554 Updated CM schema
2024-06-24 08:24:45 -07:00
..
_exported_templates
Tweaked API docs format and content. Fixed build warnings.
2022-07-23 15:59:52 -06:00
docs
Fixed docs
2024-06-20 16:36:01 -07:00
images
potential v2 icon
2023-12-02 08:41:12 -07:00
schemas
Updated CM schema
2024-06-24 08:24:45 -07:00
templates
new docfx!
2023-12-02 19:09:37 -07: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
Updated CM schema
2024-06-24 08:24:45 -07:00
index.md
Updates V2 API docs (#3060)
2023-12-17 21:52:59 -07: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.