csharp/gui-cs.Terminal.Gui @ v1_release

Tig 25b15515db Upgraded actions/upload-pages-artifact@v3		6 달 전
..
_exported_templates	0dcbdb847c Tweaked API docs format and content. Fixed build warnings.	3 년 전
docs	25b15515db Upgraded actions/upload-pages-artifact@v3	6 달 전
images	5461e3779b Adds F7History icon (#2963)	2 년 전
overrides	a69ceb2a29 testing improve this doc...	3 년 전
templates	2a679e01bd Republish v1 docs using new docfx	2 년 전
README.md	2a679e01bd Republish v1 docs using new docfx	2 년 전
aboutbox.png	7f27d78cc7 Release Candiate 2 (#1248)	4 년 전
build.ps1	2a679e01bd Republish v1 docs using new docfx	2 년 전
docfx.json	fffa8de04c Fixed API doc TOC tree expansion (#3201)	1 년 전
index.md	3a185cef39 Migrating api docs for v1	6 달 전
runbuild.cmd	239191cde0 Fixes #1434. Regenerating the docs. (#1528)	4 년 전
toc.yml	0160db7d0f Migrating api docs for v1 6	6 달 전

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

Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
Change to the ./docfx folder and run ./build.ps1
Browse to http://localhost:8080 and verify everything looks good.
Hit ctrl-c to stop the script.

README.md

To Generate the Docs Locally