Răsfoiți Sursa

API doc updates (#3928)

Tig 5 luni în urmă
părinte
comite
b62e826576

BIN
docfx/aboutbox.png


+ 13 - 8
docfx/docs/index.md

@@ -11,7 +11,7 @@
 * **[Extensible UI](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.View.html)** - All visible UI elements are subclasses of the `View` class, and these in turn can contain an arbitrary number of sub-views. Dozens of [Built-in Views](views.md) are provided.
 * **[Keyboard](keyboard.md) and [Mouse](mouse.md) Input** - The library handles all the details of input processing and provides a simple event-based API for applications to consume.
 * **[Powerful Layout Engine](layout.md)** - The layout engine makes it easy to lay out controls relative to each other and enables dynamic terminal UIs. 
-* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [`ConfigurationManager`](~/api/Terminal.Gui.ConfigurationManager.yml) class.
+* **[Machine, User, and App-Level Configuration](config.md)** - Persistent configuration settings, including overriding default look & feel with Themes, keyboard bindings, and more via the [ConfigurationManager](~/api/Terminal.Gui.ConfigurationManager.yml) class.
 * **[Clipboard support](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.Clipboard.html)** - Cut, Copy, and Paste is provided through the [`Clipboard`] class.
 * **Multi-tasking** - The [Mainloop](https://gui-cs.github.io/Terminal.GuiV2Docs/api/Terminal.Gui.MainLoop.html) supports processing events, idle handlers, and timers. Most classes are safe for threading.
 * **[Reactive Extensions](https://github.com/dotnet/reactive)** - Use reactive extensions and benefit from increased code readability, and the ability to apply the MVVM pattern and [ReactiveUI](https://www.reactiveui.net/) data bindings. See the [source code](https://github.com/gui-cs/Terminal.GuiV2Docs/tree/master/ReactiveExample) of a sample app.
@@ -20,17 +20,22 @@ See [What's New in V2 For more](newinv2.md).
 
 ## Conceptual Documentation
 
-* [Guide to Migrating from Terminal.Gui v1](migratingfromv1.md)
-* [List of Views](views.md)
-* [Layout Engine](layout.md)
-* [Navigation](navigation.md)
-* [Keyboard API](keyboard.md)
-* [Mouse API](mouse.md)
 * [Arrangement API](arrangement.md)
 * [Configuration and Theme Manager](config.md)
-* [Multi-tasking and the Application Main Loop](mainloop.md)
+* [Cursor Deep Dive](cursor.md)
 * [Cross-platform Driver Model](drivers.md)
 * [Dim.Auto Deep Dive](dimauto.md)
+* [Drawing](drawing.md)
+* [Events Deep Dive](events.md)
+* [Keyboard API](keyboard.md)
+* [Layout Engine](layout.md)
+* [Migrating from Terminal.Gui v1](migratingfromv1.md)
+* [Mouse API](mouse.md)
+* [Multi-tasking and the Application Main Loop](mainloop.md)
+* [Navigation](navigation.md)
+* [View Deep Dive](View.md)
+* [Views](views.md)
+* [Scrolling Deep Dive](scrolling.md)
 * [TableView Deep Dive](tableview.md)
 * [TreeView Deep Dive](treeview.md)
 

+ 20 - 16
docfx/docs/toc.yml

@@ -6,32 +6,36 @@
   href: newinv2.md
 - name: v1 To v2 Migration
   href: migratingfromv1.md  
-- name: View Deep Dive
-  href: View.md  
-- name: List of Views
-  href: views.md
-- name: Layout Engine
-  href: layout.md
 - name: Arrangement
   href: arrangement.md
-- name: Navigation
-  href: navigation.md
-- name: Scrolling
-  href: scrolling.md
-- name: Keyboard
-  href: keyboard.md
-- name: Mouse
-  href: mouse.md
 - name: Configuration
   href: config.md
+- name: Cursor
+  href: cursor.md
+- name: Dim.Auto Deep Dive
+  href: dimauto.md
 - name: Drawing
   href: drawing.md
 - name: Drivers
   href: drivers.md
+- name: Events Deep Dive
+  href: events.md
+- name: Keyboard
+  href: keyboard.md
+- name: Layout Engine
+  href: layout.md
+- name: Mouse
+  href: mouse.md
 - name: Multi-Tasking
   href: mainloop.md
-- name: Dim.Auto Deep Dive
-  href: dimauto.md
+- name: Navigation
+  href: navigation.md
+- name: View Deep Dive
+  href: View.md  
+- name: View List
+  href: views.md
+- name: Scrolling
+  href: scrolling.md
 - name: TableView Deep Dive
   href: tableview.md
 - name: TreeView Deep Dive

BIN
docfx/images/sample.gif


BIN
docfx/images/sample.png


BIN
docfx/images/wizard.gif


+ 1 - 1
docfx/index.md

@@ -8,7 +8,7 @@ A toolkit for building rich console apps for .NET that run on Windows, the Mac,
 
 ## Terminal.Gui API Documentation
 
-* [Conceptual Documentation](docs/index.md)
+* [Conceptual Docs & Deep Dives](docs/index.md)
 * [API Reference](~/api/Terminal.Gui.yml)
 
 ## UI Catalog

+ 1 - 1
docfx/toc.yml

@@ -1,4 +1,4 @@
-- name: Conceptual Docs
+- name: Conceptual Docs & Deep Dives
   href: docs/
 
 - name: API