Terminal.Gui

mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00

Files

BDisp 239191cde0 Fixes #1434 . Regenerating the docs. (#1528 )

* Fixes #1434. Regenerating the docs.

* Fixing warnings on docs regeneration and improving.

2021-12-18 05:33:40 -08:00

articles

Fixes #1434 . Regenerating the docs. (#1528 )

2021-12-18 05:33:40 -08:00

images

updated docs to match new layout

2020-05-27 17:38:23 -06:00

templates/material

Updated docfx. Generated fresh docs. Added an icon.

2020-05-23 02:30:00 -06:00

aboutbox.png

Release Candiate 2 (#1248 )

2021-04-26 09:31:37 -07:00

build.ps1

generated docs

2020-10-22 12:31:38 -06:00

docfx.json

Fixes #1434 . Regenerating the docs. (#1528 )

2021-12-18 05:33:40 -08:00

index.md

Fixes #1434 . Regenerating the docs. (#1528 )

2021-12-18 05:33:40 -08:00

README.md

generated docs

2020-10-22 12:31:38 -06:00

runbuild.cmd

Fixes #1434 . Regenerating the docs. (#1528 )

2021-12-18 05:33:40 -08:00

sample.gif

Version 1.0 (#1227 )

2021-04-28 09:09:51 -07:00

sample.png

updated gif

2020-07-15 07:15:09 -07:00

toc.yml

updated docs to match new layout

2020-05-27 17:38:23 -06:00

README.md

This folder generates the API docs for Terminal.Gui.

The API documentation is generated using the DocFX tool. The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages (https://migueldeicaza.github.io/gui.cs/).

To Generate the Docs

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.

If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.