Tig 3f3ceae9c7 API docs vor 10 Monaten
..
_exported_templates eca05c9187 Apply docs changes from v2_2491-Overlapped vor 11 Monaten
docs 3f3ceae9c7 API docs vor 10 Monaten
images d71fa11a2b Fixed README, Showcase, and images vor 1 Jahr
schemas 10bdd4bc0f V2 config schema (#3760) vor 11 Monaten
README.md a96c2588d5 Tweaks to api docs vor 1 Jahr
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) vor 4 Jahren
build.ps1 ab5848902a new docfx! vor 1 Jahr
docfx.json 84642bec1b Fixed doc build to include schemas vor 11 Monaten
index.md eca05c9187 Apply docs changes from v2_2491-Overlapped vor 11 Monaten
toc.yml a96c2588d5 Tweaks to api docs vor 1 Jahr

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.