Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 33816af03c
Branches Tags
gui-cs.Terminal...
/
docfx
Tig Kindel 6930043911 Merge branch 'develop' 1 year ago
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
docs 2a679e01bd Republish v1 docs using new docfx 1 year ago
images 5461e3779b Adds F7History icon (#2963) 1 year ago
overrides a69ceb2a29 testing improve this doc... 2 years ago
templates 2a679e01bd Republish v1 docs using new docfx 1 year ago
README.md 2a679e01bd Republish v1 docs using new docfx 1 year ago
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) 4 years ago
build.ps1 2a679e01bd Republish v1 docs using new docfx 1 year ago
docfx.json fffa8de04c Fixed API doc TOC tree expansion (#3201) 1 year ago
index.md 2a679e01bd Republish v1 docs using new docfx 1 year ago
runbuild.cmd 239191cde0 Fixes #1434. Regenerating the docs. (#1528) 3 years ago
toc.yml 1111c82595 Fixed api link prob 1 year ago

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.