gui-cs.Terminal.Gui/docs



Toggle navigation

Search Results for

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

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.

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.

In This Article

Back to top


Generated by DocFX