From 3e5e22d6c249a3cae4ebb4e50db91e6d13a173ce Mon Sep 17 00:00:00 2001
From: Martin Andersen <martin.andersen@outlook.com>
Date: Mon, 26 Oct 2020 14:58:55 +0100
Subject: [PATCH] Update documentation
- ExceptionFormat -> ExceptionFormats.
- Fix link to documentation.
- Add cross reference to Styles.
- Render table in example code.
- Add code for setting background color.
---
README.jp.md | 4 ++--
README.md | 2 +-
docs/README.md | 2 +-
docs/input/exceptions.md | 4 ++--
docs/input/markup.md | 9 +++++----
5 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/README.jp.md b/README.jp.md
index d9a072d..ebd5970 100644
--- a/README.jp.md
+++ b/README.jp.md
@@ -381,8 +381,8 @@ AnsiConsole.WriteException(ex);
```csharp
AnsiConsole.WriteException(ex,
- ExceptionFormat.ShortenPaths | ExceptionFormat.ShortenTypes |
- ExceptionFormat.ShortenMethods | ExceptionFormat.ShowLinks);
+ ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
+ ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
```
diff --git a/README.md b/README.md
index 2402f61..2452830 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,7 @@ regular `System.Console` API.
If the current terminal does not support ANSI escape sequences,
`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._
### Using the static API
diff --git a/docs/README.md b/docs/README.md
index 0cec5dd..19b1814 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -10,7 +10,7 @@ The documentation site uses [Statiq](https://statiq.dev), a static site generato
> 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.**
diff --git a/docs/input/exceptions.md b/docs/input/exceptions.md
index fbe7b48..9dce0b9 100644
--- a/docs/input/exceptions.md
+++ b/docs/input/exceptions.md
@@ -19,8 +19,8 @@ the hyperlinks are clickable is up to the terminal.
```csharp
AnsiConsole.WriteException(ex,
- ExceptionFormat.ShortenPaths | ExceptionFormat.ShortenTypes |
- ExceptionFormat.ShortenMethods | ExceptionFormat.ShowLinks);
+ ExceptionFormats.ShortenPaths | ExceptionFormats.ShortenTypes |
+ ExceptionFormats.ShortenMethods | ExceptionFormats.ShowLinks);
```
<img src="assets/images/compact_exception.png" style="max-width: 100%;">
diff --git a/docs/input/markup.md b/docs/input/markup.md
index c500d3c..8570a9f 100644
--- a/docs/input/markup.md
+++ b/docs/input/markup.md
@@ -6,7 +6,7 @@ The class `Markup` allows you to output rich text to the console.
# 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 `[/]`.
```csharp
@@ -21,6 +21,7 @@ rendering of `IRenderable` also have overloads for rendering rich text.
var table = new Table();
table.AddColumn(new TableColumn(new Markup("[yellow]Foo[/]")));
table.AddColumn(new TableColumn("[blue]Bar[/]"));
+AnsiConsole.Render(table);
```
# 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
`on`.
-```
-[bold yellow on blue]Hello[/]
-[default on blue]World[/]
+```csharp
+AnsiConsole.Markup("[bold yellow on blue]Hello[/]");
+AnsiConsole.Markup("[default on blue]World[/]");
```
# Rendering emojis