Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: ce7fc04100
Branches Tags
gui-cs.Terminal...
/
docfx
Tig acb5979e6c Cleans up/Refactors `View.Subviews` (#3962) 5 months ago
..
_exported_templates eca05c9187 Apply docs changes from v2_2491-Overlapped 11 months ago
docs acb5979e6c Cleans up/Refactors `View.Subviews` (#3962) 5 months ago
images b62e826576 API doc updates (#3928) 5 months ago
schemas 10bdd4bc0f V2 config schema (#3760) 11 months ago
README.md a96c2588d5 Tweaks to api docs 1 year ago
aboutbox.png b62e826576 API doc updates (#3928) 5 months ago
build.ps1 ab5848902a new docfx! 1 year ago
docfx.json 84642bec1b Fixed doc build to include schemas 11 months ago
index.md b62e826576 API doc updates (#3928) 5 months ago
toc.yml b62e826576 API doc updates (#3928) 5 months ago

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.