tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-16 17:02:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
- ExceptionFormat -> ExceptionFormats.
- Fix link to documentation.
- Add cross reference to Styles.
- Render table in example code.
- Add code for setting background color.
This commit is contained in:
Martin Andersen 2020-10-26 14:58:55 +01:00 committed by Patrik Svensson
parent 10daf727e9
commit 3e5e22d6c2
5 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.jp.md
View File

@ -381,8 +381,8 @@ AnsiConsole.WriteException(ex);
```csharp ```csharp
AnsiConsole.WriteException(ex, AnsiConsole.WriteException(ex,
ExceptionFormat.ShortenPaths | ExceptionFormat.ShortenTypes | ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
ExceptionFormat.ShortenMethods | ExceptionFormat.ShowLinks); ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
``` ```
![exception](docs/input/assets/images/compact_exception.png) ![exception](docs/input/assets/images/compact_exception.png)

2
README.md
View File

@ -49,7 +49,7 @@ regular `System.Console` API.
If the current terminal does not support ANSI escape sequences, If the current terminal does not support ANSI escape sequences,
`Spectre.Console` will fallback to using the `System.Console` API. `Spectre.Console` will fallback to using the `System.Console` API.
_NOTE: This library is currently under development and API's _NOTE: This library is currently under development and APIs
might change or get removed at any point up until a 1.0 release._ might change or get removed at any point up until a 1.0 release._
### Using the static API ### Using the static API

2
docs/README.md
View File

@ -10,7 +10,7 @@ The documentation site uses [Statiq](https://statiq.dev), a static site generato
> dotnet run preview --virtual-dir "spectre.console" > dotnet run preview --virtual-dir "spectre.console"
``` ```
After the build is complete, you can navigate to [http://localhost:5080/spectre.consle](http://localhost:5080/spectre.console). After the build is complete, you can navigate to [http://localhost:5080/spectre.console](http://localhost:5080/spectre.console).
**Note that the site runs under a virtual directory.** **Note that the site runs under a virtual directory.**

4
docs/input/exceptions.md
View File

@ -19,8 +19,8 @@ the hyperlinks are clickable is up to the terminal.
```csharp ```csharp
AnsiConsole.WriteException(ex, AnsiConsole.WriteException(ex,
ExceptionFormat.ShortenPaths | ExceptionFormat.ShortenTypes | ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
ExceptionFormat.ShortenMethods | ExceptionFormat.ShowLinks); ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
``` ```
<img src="assets/images/compact_exception.png" style="max-width: 100%;"> <img src="assets/images/compact_exception.png" style="max-width: 100%;">

9
docs/input/markup.md
View File

@ -6,7 +6,7 @@ The class `Markup` allows you to output rich text to the console.
# Syntax # Syntax
Console markup uses a syntax inspired by bbcode. If you write the style (see Styles) Console markup uses a syntax inspired by bbcode. If you write the style (see [Styles](xref:styles))
in square brackets, e.g. `[bold red]`, that style will apply until it is closed with a `[/]`. in square brackets, e.g. `[bold red]`, that style will apply until it is closed with a `[/]`.
```csharp ```csharp
@ -21,6 +21,7 @@ rendering of `IRenderable` also have overloads for rendering rich text.
var table = new Table(); var table = new Table();
table.AddColumn(new TableColumn(new Markup("[yellow]Foo[/]"))); table.AddColumn(new TableColumn(new Markup("[yellow]Foo[/]")));
table.AddColumn(new TableColumn("[blue]Bar[/]")); table.AddColumn(new TableColumn("[blue]Bar[/]"));
AnsiConsole.Render(table);
``` ```
# Convenience methods # Convenience methods
@ -54,9 +55,9 @@ AnsiConsole.Markup("[red]{0}[/]", "Hello [World]".EscapeMarkup());
You can set the background color in markup by prefixing the color with You can set the background color in markup by prefixing the color with
`on`. `on`.
``` ```csharp
[bold yellow on blue]Hello[/] AnsiConsole.Markup("[bold yellow on blue]Hello[/]");
[default on blue]World[/] AnsiConsole.Markup("[default on blue]World[/]");
``` ```
# Rendering emojis # Rendering emojis