Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
152bb1818362e794cf2a0689b57cfa5951f67c40
Terminal.Gui/docfx
History
Tig Kindel 6930043911 Merge branch 'develop'
2024-01-22 07:06:06 -07:00
..
_exported_templates
Tweaked API docs format and content. Fixed build warnings.
2022-07-23 15:59:52 -06:00
docs
Republish v1 docs using new docfx
2023-12-03 11:02:22 -07:00
images
Adds F7History icon (#2963)
2023-11-08 08:40:55 -07:00
overrides
testing improve this doc...
2022-10-21 09:31:41 -07:00
templates
Republish v1 docs using new docfx
2023-12-03 11:02:22 -07:00
aboutbox.png
Release Candiate 2 (#1248)
2021-04-26 09:31:37 -07:00
build.ps1
Republish v1 docs using new docfx
2023-12-03 11:02:22 -07:00
docfx.json
Fixed API doc TOC tree expansion (#3201)
2024-01-20 11:24:32 -07:00
index.md
Republish v1 docs using new docfx
2023-12-03 11:02:22 -07:00
README.md
Republish v1 docs using new docfx
2023-12-03 11:02:22 -07:00
runbuild.cmd
Fixes #1434. Regenerating the docs. (#1528)
2021-12-18 05:33:40 -08:00
toc.yml
Fixed api link prob
2023-12-03 11:48:17 -07:00

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.