Terminal.Gui

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

Files

Thomas Nind 63c20164ab Update tableview.md

Removed reference to lineNumber in example code

2021-01-27 16:09:59 +00:00

articles

Update tableview.md

2021-01-27 16:09:59 +00: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

build.ps1

generated docs

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

docfx.json

updated api docs; implemented inheritdoc; may break deploy

2020-06-03 18:18:19 -06:00

index.md

merged master and updated readme release notes

2020-09-09 12:38:31 -07:00

README.md

generated docs

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

sample.gif

updated readme gif

2020-07-15 07:17:46 -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.