Tig 304784cbe7 Code cleanup and refactor 1 vuosi sitten
..
_exported_templates eca05c9187 Apply docs changes from v2_2491-Overlapped 1 vuosi sitten
docs 304784cbe7 Code cleanup and refactor 1 vuosi sitten
images d71fa11a2b Fixed README, Showcase, and images 1 vuosi sitten
schemas 10bdd4bc0f V2 config schema (#3760) 1 vuosi sitten
README.md a96c2588d5 Tweaks to api docs 2 vuotta sitten
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) 4 vuotta sitten
build.ps1 ab5848902a new docfx! 2 vuotta sitten
docfx.json 84642bec1b Fixed doc build to include schemas 1 vuosi sitten
index.md eca05c9187 Apply docs changes from v2_2491-Overlapped 1 vuosi sitten
toc.yml a96c2588d5 Tweaks to api docs 2 vuotta sitten

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.