Startseite Erkunden Hilfe
Anmelden
csharp
/
gui-cs.Terminal.Gui
Mirror von https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 47e1c87590
Branches Tags
gui-cs.Terminal...
/
docfx
Tig c537c347ee doc tweak vor 1 Jahr
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. vor 3 Jahren
docs c537c347ee doc tweak vor 1 Jahr
images d71fa11a2b Fixed README, Showcase, and images vor 1 Jahr
schemas fab361d554 Updated CM schema vor 1 Jahr
templates ab5848902a new docfx! vor 1 Jahr
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 fab361d554 Updated CM schema vor 1 Jahr
index.md 49ec9b7342 Updates V2 API docs (#3060) vor 1 Jahr
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.