Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 4bf19dda7b
Branches Tags
gui-cs.Terminal...
/
docfx
Tig cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
..
_exported_templates cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
docs cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
images cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
includes cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
schemas 3e2eebfd2c Fixes #4057 - MASSIVE! Fully implements `ColorScheme`->`Scheme` + `VisualRole` + `Colors.`->`SchemeManager.` (#4062) 6 months ago
scripts cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
README.md cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
aboutbox.png cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
docfx.json cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
index.md cab22566ea Fixes #4107 - Revamps Terminal.Gui's `namespace` (#4109) 6 months ago
toc.yml b62e826576 API doc updates (#3928) 9 months ago

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.

To Generate the Docs Locally

  1. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
  2. Run ./docfx/scripts/Build.ps1
  3. Browse to http://localhost:8080 and verify everything looks good.
  4. Hit ctrl-c to stop the script.

To update views.md

  1. Switch to the ./docfx folder
  2. Run ./scripts/generate-views-doc.ps1
  3. Commit the changes to docs/views.md