mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-06-18 21:08:15 +08:00
Docs redesign (#728)
* Adding a dark mode * Adding reference for types to summary pages * Adding API Reference * Adding modifiers to methods/fields/etc * Minimizing files input * Caching a lot of the output pages * Cache only for each execution * Adding API references to existing docs
This commit is contained in:
@ -5,6 +5,8 @@ Highlights:
|
||||
- Custom colors
|
||||
- Labels
|
||||
- Use your own data with a converter.
|
||||
Reference: T:Spectre.Console.BarChart
|
||||
|
||||
---
|
||||
|
||||
Use `BarChart` to render bar charts to the console.
|
||||
|
@ -6,6 +6,8 @@ Highlights:
|
||||
- Include highlighted events.
|
||||
- Culture aware.
|
||||
- Custom headers.
|
||||
Reference: T:Spectre.Console.Calendar
|
||||
|
||||
---
|
||||
|
||||
The `Calendar` is used to render a calendar to the terminal.
|
||||
|
@ -1,6 +1,7 @@
|
||||
Title: Canvas Image
|
||||
Order: 70
|
||||
Description: "Use *ImageSharp* to parse images and render them as Ascii art to the console."
|
||||
Reference: T:Spectre.Console.CanvasImage
|
||||
---
|
||||
|
||||
To add [ImageSharp](https://github.com/SixLabors/ImageSharp) superpowers to
|
||||
|
@ -1,6 +1,7 @@
|
||||
Title: Canvas
|
||||
Order: 60
|
||||
Description: "**Canvas** is a widget that allows you to render arbitrary pixels to the console."
|
||||
Reference: T:Spectre.Console.Canvas
|
||||
---
|
||||
|
||||
`Canvas` is a widget that allows you to render arbitrary "pixels"
|
||||
|
@ -2,6 +2,7 @@ Title: Figlet
|
||||
Order: 50
|
||||
RedirectFrom: figlet
|
||||
Description: "*Spectre.Console* can render FIGlet text by using the **FigletText** class."
|
||||
Reference: T:Spectre.Console.FigletText
|
||||
---
|
||||
|
||||
Spectre.Console can render [FIGlet](http://www.figlet.org/) text by using the `FigletText` class.
|
||||
|
@ -5,6 +5,7 @@ Description: "The **Rule** class is used to render a horizontal rule (line) to t
|
||||
Highlights:
|
||||
- Custom colors for line and title.
|
||||
- Specify left, center or right aligned title.
|
||||
Reference: T:Spectre.Console.Rule
|
||||
|
||||
---
|
||||
|
||||
|
@ -2,6 +2,7 @@ Title: Table
|
||||
Order: 0
|
||||
RedirectFrom: tables
|
||||
Description: "Tables are a perfect way of displaying tabular data in a terminal. *Spectre.Console* is super smart about rendering tables and will adjust all columns to fit whatever is inside them."
|
||||
Reference: T:Spectre.Console.Table
|
||||
---
|
||||
|
||||
Tables are a perfect way of displaying tabular data in a terminal.
|
||||
|
@ -4,6 +4,8 @@ Description: "The **Tree** widget can be used to render hierarchical data."
|
||||
Highlights:
|
||||
- Custom colors and styles for guidelines.
|
||||
- Include any *Spectre.Console* widgets as child nodes.
|
||||
Reference: T:Spectre.Console.Tree
|
||||
|
||||
---
|
||||
|
||||
The `Tree` widget can be used to render hierarchical data.
|
||||
|
Reference in New Issue
Block a user