Tig c537c347ee doc tweak hace 1 año
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. hace 3 años
docs c537c347ee doc tweak hace 1 año
images d71fa11a2b Fixed README, Showcase, and images hace 1 año
schemas fab361d554 Updated CM schema hace 1 año
templates ab5848902a new docfx! hace 1 año
README.md a96c2588d5 Tweaks to api docs hace 1 año
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) hace 4 años
build.ps1 ab5848902a new docfx! hace 1 año
docfx.json fab361d554 Updated CM schema hace 1 año
index.md 49ec9b7342 Updates V2 API docs (#3060) hace 1 año
toc.yml a96c2588d5 Tweaks to api docs hace 1 año

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.