Domů Procházet Nápověda
Přihlásit se
csharp
/
gui-cs.Terminal.Gui
zrcadlo https://github.com/gui-cs/Terminal.Gui.git
2
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: 4eabd71b16
Větve Značky
gui-cs.Terminal...
/
docfx
Tig fffa8de04c Fixed API doc TOC tree expansion (#3201) před 1 rokem
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. před 3 roky
docs 2a679e01bd Republish v1 docs using new docfx před 1 rokem
images 1288dedfdf Moved showcase and examples out of Readme, created showcase.md před 2 roky
overrides a69ceb2a29 testing improve this doc... před 2 roky
templates 2a679e01bd Republish v1 docs using new docfx před 1 rokem
README.md 2a679e01bd Republish v1 docs using new docfx před 1 rokem
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) před 4 roky
build.ps1 2a679e01bd Republish v1 docs using new docfx před 1 rokem
docfx.json fffa8de04c Fixed API doc TOC tree expansion (#3201) před 1 rokem
index.md 2a679e01bd Republish v1 docs using new docfx před 1 rokem
runbuild.cmd 239191cde0 Fixes #1434. Regenerating the docs. (#1528) před 3 roky
toc.yml 1111c82595 Fixed api link prob před 1 rokem

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. The Action publishes the docs to the gh-pages branch, which gets published to https://gui-cs.github.io/Terminal.Gui/.

NOTE: the v2 are generated from another repository (https://github.com/gui-cs/Terminal.GuiV2Docs) and are published here: https://gui-cs.github.io/Terminal.GuiV2Docs/.

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.