Accueil Explorer Aide
Connexion
csharp
/
gui-cs.Terminal.Gui
miroir de https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Fichiers Tickets 0 Wiki
Aborescence: d2c95ed882
Branches Tags
gui-cs.Terminal...
/
docfx
Charlie Kindel 7f27d78cc7 Release Candiate 2 (#1248) il y a 4 ans
..
articles db3ddab2b8 Update overview.md (#1233) il y a 4 ans
images deaa17fd4f updated docs to match new layout il y a 5 ans
templates 14f08a8d63 Updated docfx. Generated fresh docs. Added an icon. il y a 5 ans
README.md 75bebb12f9 generated docs il y a 4 ans
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) il y a 4 ans
build.ps1 75bebb12f9 generated docs il y a 4 ans
docfx.json e87b56cd77 updated api docs; implemented inheritdoc; may break deploy il y a 5 ans
index.md 4da9ad0e89 Fix 1130 broken links (#1131) il y a 4 ans
sample.gif 56fbf9819b updated readme gif il y a 5 ans
sample.png 3befb45673 updated gif il y a 5 ans
toc.yml deaa17fd4f updated docs to match new layout il y a 5 ans

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

  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.