Improved style docs
@@ -1,23 +1,42 @@
|
|||||||
# Gold Style Reference
|
# Gold Style Reference
|
||||||
|
|
||||||
## document
|
## Block Elements
|
||||||
|
|
||||||
|
Block elements contain other elements and are rendered around them. All block
|
||||||
|
elements support the following style settings:
|
||||||
|
|
||||||
|
| Attribute | Value | Description |
|
||||||
|
| ---------------- | ------ | -------------------------------------------------- |
|
||||||
|
| prefix | string | Printed before the block's first element |
|
||||||
|
| suffix | string | Printed after the block's last element |
|
||||||
|
| styled_prefix | string | Printed before the block's first element |
|
||||||
|
| styled_suffix | string | Printed after the block's last element |
|
||||||
|
| indent | number | Specifies the indentation of the block |
|
||||||
|
| margin | number | Specifies the margin around the block |
|
||||||
|
| color | color | Defines the default text color for the block |
|
||||||
|
| background_color | color | Defines the default background color for the block |
|
||||||
|
|
||||||
|
Elements inside a block inherit the block's following style settings:
|
||||||
|
|
||||||
|
| Attribute | Value | Description |
|
||||||
|
| ---------------- | ----- | -------------------------------------------------- |
|
||||||
|
| color | color | Defines the default text color for the block |
|
||||||
|
| background_color | color | Defines the default background color for the block |
|
||||||
|
| bold | bool | Increases text intensity |
|
||||||
|
| faint | bool | Decreases text intensity |
|
||||||
|
| italic | bool | Prints the text in italic |
|
||||||
|
| crossed_out | bool | Enables strikethrough as text decoration |
|
||||||
|
| underline | bool | Enables underline as text decoration |
|
||||||
|
| overlined | bool | Enables overline as text decoration |
|
||||||
|
| blink | bool | Enables blinking text |
|
||||||
|
| conceal | bool | Conceals / hides the text |
|
||||||
|
| inverse | bool | Swaps fore- & background colors |
|
||||||
|
|
||||||
|
### document
|
||||||
|
|
||||||
The `document` element represents the markdown's body.
|
The `document` element represents the markdown's body.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ----------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the first element during rendering |
|
|
||||||
| suffix | string | Printed after the last element during rendering |
|
|
||||||
| styled_prefix | string | Printed before the first element during rendering |
|
|
||||||
| styled_suffix | string | Printed after the last element during rendering |
|
|
||||||
| indent | number | Specifies the indentation of the document |
|
|
||||||
| margin | number | Specifies the margin around the document |
|
|
||||||
| color | color | Defines the default text color for the document |
|
|
||||||
| background_color | color | Defines the default background color for the document |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
Style:
|
||||||
|
|
||||||
@@ -30,24 +49,11 @@ Style:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## paragraph
|
### paragraph
|
||||||
|
|
||||||
The `paragraph` element represents a paragraph in the document.
|
The `paragraph` element represents a paragraph in the document.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | --------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the first element in a paragraph |
|
|
||||||
| suffix | string | Printed after the last element in a paragraph |
|
|
||||||
| styled_prefix | string | Printed before the first element in a paragraph |
|
|
||||||
| styled_suffix | string | Printed after the last element in a paragraph |
|
|
||||||
| indent | number | Specifies the indentation of paragraphs |
|
|
||||||
| margin | number | Specifies the margin around paragraphs |
|
|
||||||
| color | color | Defines the default text color for paragraphs |
|
|
||||||
| background_color | color | Defines the default background color for paragraphs |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
Style:
|
||||||
|
|
||||||
@@ -59,39 +65,17 @@ Style:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## heading
|
### heading
|
||||||
|
|
||||||
The `heading` element represents a heading.
|
The `heading` element represents a heading.
|
||||||
|
|
||||||
## h1 - h6
|
### h1 - h6
|
||||||
|
|
||||||
The `h1` to `h6` elements represent headings. `h1` defines the most important
|
The `h1` to `h6` elements represent headings. `h1` defines the most important
|
||||||
heading, `h6` the least important heading. Undefined attributes are inherited
|
heading, `h6` the least important heading. Undefined attributes are inherited
|
||||||
from the `heading` element.
|
from the `heading` element.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a heading |
|
|
||||||
| suffix | string | Printed after a heading |
|
|
||||||
| styled_prefix | string | Printed before a heading |
|
|
||||||
| styled_suffix | string | Printed after a heading |
|
|
||||||
| indent | number | Specifies the indentation of headings |
|
|
||||||
| margin | number | Specifies the margin around headings |
|
|
||||||
| color | color | Defines the default text color for headings |
|
|
||||||
| background_color | color | Defines the default background color for headings |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
Markdown:
|
||||||
|
|
||||||
@@ -131,30 +115,16 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## block_quote
|
### block_quote
|
||||||
|
|
||||||
The `block_quote` element represents a quote.
|
The `block_quote` element represents a quote.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ----------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a quote |
|
|
||||||
| suffix | string | Printed after a quote |
|
|
||||||
| styled_prefix | string | Printed before a quote |
|
|
||||||
| styled_suffix | string | Printed after a quote |
|
|
||||||
| indent | number | Specifies the indentation of quotes |
|
|
||||||
| margin | number | Specifies the margin around quotes |
|
|
||||||
| color | color | Defines the default text color for quotes |
|
|
||||||
| background_color | color | Defines the default background color for quotes |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
Style:
|
||||||
|
|
||||||
```
|
```
|
||||||
"block_quote": {
|
"block_quote": {
|
||||||
"margin": 4,
|
|
||||||
"color": "200"
|
"color": "200"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -163,439 +133,42 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## text
|
### list
|
||||||
|
|
||||||
The `text` element represents a block of text.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ----------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a text gets printed |
|
|
||||||
| suffix | string | Printed after a text got printed |
|
|
||||||
| styled_prefix | string | Printed before a text gets printed |
|
|
||||||
| styled_suffix | string | Printed after a text got printed |
|
|
||||||
| color | color | Defines the default text color for the document |
|
|
||||||
| background_color | color | Defines the default background color for the document |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"text": {
|
|
||||||
"bold": true,
|
|
||||||
"color": "15",
|
|
||||||
"background_color": "57"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## list
|
|
||||||
|
|
||||||
The `list` element represents a list in the document.
|
The `list` element represents a list in the document.
|
||||||
|
|
||||||
### Attributes
|
| Attribute | Value | Description |
|
||||||
|
| ------------ | ------ | ------------------------------------------ |
|
||||||
|
| level_indent | number | Specifies the indentation for nested lists |
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
#### Example
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a list |
|
|
||||||
| suffix | string | Printed after a list |
|
|
||||||
| styled_prefix | string | Printed before a list |
|
|
||||||
| styled_suffix | string | Printed after a list |
|
|
||||||
| indent | number | Specifies the indentation of lists |
|
|
||||||
| margin | number | Specifies the margin around lists |
|
|
||||||
| color | color | Defines the default text color for lists |
|
|
||||||
| background_color | color | Defines the default background color for lists |
|
|
||||||
| level_indent | number | Specifies the indentation for nested lists |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
|
||||||
|
|
||||||
```
|
|
||||||
- First Item
|
|
||||||
- Nested List Item
|
|
||||||
- Second Item
|
|
||||||
```
|
|
||||||
|
|
||||||
Style:
|
Style:
|
||||||
|
|
||||||
```
|
```
|
||||||
"list": {
|
"list": {
|
||||||
"margin": 4,
|
|
||||||
"color": "15",
|
"color": "15",
|
||||||
"background_color": "52",
|
"background_color": "52",
|
||||||
"level_indent": 4
|
"level_indent": 4
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## item
|
### code_block
|
||||||
|
|
||||||
The `item` element represents an item in lists.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before an item |
|
|
||||||
| suffix | string | Printed after an item |
|
|
||||||
| styled_prefix | string | Printed before an item |
|
|
||||||
| styled_suffix | string | Printed after an item |
|
|
||||||
| color | color | Defines the default text color for items |
|
|
||||||
| background_color | color | Defines the default background color for items |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"item": {
|
|
||||||
"prefix": "• "
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## enumeration
|
|
||||||
|
|
||||||
The `enumeration` element represents an item in ordered lists.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before an item |
|
|
||||||
| suffix | string | Printed after an item |
|
|
||||||
| styled_prefix | string | Printed before an item |
|
|
||||||
| styled_suffix | string | Printed after an item |
|
|
||||||
| color | color | Defines the default text color for items |
|
|
||||||
| background_color | color | Defines the default background color for items |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
|
||||||
|
|
||||||
```
|
|
||||||
1. First Item
|
|
||||||
2. Second Item
|
|
||||||
```
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"enumeration": {
|
|
||||||
"prefix": ". "
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## task
|
|
||||||
|
|
||||||
The `task` element represents a task item.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before an item |
|
|
||||||
| suffix | string | Printed after an item |
|
|
||||||
| styled_prefix | string | Printed before an item |
|
|
||||||
| styled_suffix | string | Printed after an item |
|
|
||||||
| color | color | Defines the default text color for items |
|
|
||||||
| background_color | color | Defines the default background color for items |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
| ticked | string | Prefix for finished tasks |
|
|
||||||
| unticked | string | Prefix for unfinished tasks |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
|
||||||
|
|
||||||
```
|
|
||||||
- [x] Finished Task
|
|
||||||
- [ ] Outstanding Task
|
|
||||||
```
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"task": {
|
|
||||||
"ticked": "✓ ",
|
|
||||||
"unticked": "✗ "
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## link
|
|
||||||
|
|
||||||
The `link` element represents a link.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the link |
|
|
||||||
| suffix | string | Printed after the link |
|
|
||||||
| styled_prefix | string | Printed before the link |
|
|
||||||
| styled_suffix | string | Printed after the link |
|
|
||||||
| color | color | Defines the default text color for links |
|
|
||||||
| background_color | color | Defines the default background color for links |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
|
||||||
|
|
||||||
```
|
|
||||||
This is a [link](https://charm.sh).
|
|
||||||
```
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"link": {
|
|
||||||
"color": "123",
|
|
||||||
"underline": true,
|
|
||||||
"prefix": "(",
|
|
||||||
"suffix": ")"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## link_text
|
|
||||||
|
|
||||||
The `link_text` element represents the text associated with a link.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the text |
|
|
||||||
| suffix | string | Printed after the text |
|
|
||||||
| styled_prefix | string | Printed before the text |
|
|
||||||
| styled_suffix | string | Printed after the text |
|
|
||||||
| color | color | Defines the default text color for the text |
|
|
||||||
| background_color | color | Defines the default background color for the text |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"link_text": {
|
|
||||||
"color": "123",
|
|
||||||
"bold": true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## image
|
|
||||||
|
|
||||||
The `image` element represents an image.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ----------------------------------------------- |
|
|
||||||
| prefix | string | Printed before an image |
|
|
||||||
| suffix | string | Printed after an image |
|
|
||||||
| styled_prefix | string | Printed before an image |
|
|
||||||
| styled_suffix | string | Printed after an image |
|
|
||||||
| color | color | Defines the default text color for images |
|
|
||||||
| background_color | color | Defines the default background color for images |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
|
||||||
|
|
||||||
```
|
|
||||||
.
|
|
||||||
```
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"image": {
|
|
||||||
"color": "123",
|
|
||||||
"prefix": "[Image: ",
|
|
||||||
"suffix": "]"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## image_text
|
|
||||||
|
|
||||||
The `image_text` element represents the text associated with an image.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the text |
|
|
||||||
| suffix | string | Printed after the text |
|
|
||||||
| styled_prefix | string | Printed before the text |
|
|
||||||
| styled_suffix | string | Printed after the text |
|
|
||||||
| color | color | Defines the default text color for the text |
|
|
||||||
| background_color | color | Defines the default background color for the text |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"image_text": {
|
|
||||||
"color": "8"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## code
|
|
||||||
|
|
||||||
The `code` element represents an inline code segment.
|
|
||||||
|
|
||||||
### Attributes
|
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ---------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the code |
|
|
||||||
| suffix | string | Printed after the code |
|
|
||||||
| styled_prefix | string | Printed before the code |
|
|
||||||
| styled_suffix | string | Printed after the code |
|
|
||||||
| color | color | Defines the default text color for codes |
|
|
||||||
| background_color | color | Defines the default background color for codes |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Style:
|
|
||||||
|
|
||||||
```
|
|
||||||
"code": {
|
|
||||||
"color": "200"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Output:
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## code_block
|
|
||||||
|
|
||||||
The `code_block` element represents a block of code.
|
The `code_block` element represents a block of code.
|
||||||
|
|
||||||
### Attributes
|
| Attribute | Value | Description |
|
||||||
|
| --------- | ------ | --------------------------------------------------------------- |
|
||||||
| Attribute | Value | Description |
|
| theme | string | Defines the [Chroma][chroma] theme used for syntax highlighting |
|
||||||
| ---------------- | ------ | --------------------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a code block |
|
|
||||||
| suffix | string | Printed after a code block |
|
|
||||||
| styled_prefix | string | Printed before a code block |
|
|
||||||
| styled_suffix | string | Printed after a code block |
|
|
||||||
| indent | number | Specifies the indentation of code blocks |
|
|
||||||
| margin | number | Specifies the margin around code blocks |
|
|
||||||
| theme | string | Defines the [Chroma][chroma] theme used for syntax highlighting |
|
|
||||||
| color | color | Defines the default text color for code blocks |
|
|
||||||
| background_color | color | Defines the default background color for code blocks |
|
|
||||||
|
|
||||||
[chroma]: https://github.com/alecthomas/chroma
|
[chroma]: https://github.com/alecthomas/chroma
|
||||||
|
|
||||||
### Example
|
#### Example
|
||||||
|
|
||||||
Style:
|
Style:
|
||||||
|
|
||||||
```
|
```
|
||||||
"code_block": {
|
"code_block": {
|
||||||
"margin": 4,
|
|
||||||
"color": "200",
|
"color": "200",
|
||||||
"theme": "solarized-dark"
|
"theme": "solarized-dark"
|
||||||
}
|
}
|
||||||
@@ -605,24 +178,11 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## table
|
### table
|
||||||
|
|
||||||
The `table` element represents a table of data.
|
The `table` element represents a table of data.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ----------------------------------------------- |
|
|
||||||
| prefix | string | Printed before a table |
|
|
||||||
| suffix | string | Printed after a table |
|
|
||||||
| styled_prefix | string | Printed before a table |
|
|
||||||
| styled_suffix | string | Printed after a table |
|
|
||||||
| indent | number | Specifies the indentation of tables |
|
|
||||||
| margin | number | Specifies the margin around tables |
|
|
||||||
| color | color | Defines the default text color for tables |
|
|
||||||
| background_color | color | Defines the default background color for tables |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
Markdown:
|
||||||
|
|
||||||
@@ -645,31 +205,231 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## emph
|
## Inline Elements
|
||||||
|
|
||||||
|
All inline elements support the following style settings:
|
||||||
|
|
||||||
|
| Attribute | Value | Description |
|
||||||
|
| ---------------- | ------ | ----------------------------------------------------- |
|
||||||
|
| prefix | string | Printed before the element |
|
||||||
|
| suffix | string | Printed after the element |
|
||||||
|
| styled_prefix | string | Printed before the element |
|
||||||
|
| styled_suffix | string | Printed after the element |
|
||||||
|
| color | color | Defines the default text color for the document |
|
||||||
|
| background_color | color | Defines the default background color for the document |
|
||||||
|
| bold | bool | Increases text intensity |
|
||||||
|
| faint | bool | Decreases text intensity |
|
||||||
|
| italic | bool | Prints the text in italic |
|
||||||
|
| crossed_out | bool | Enables strikethrough as text decoration |
|
||||||
|
| underline | bool | Enables underline as text decoration |
|
||||||
|
| overlined | bool | Enables overline as text decoration |
|
||||||
|
| blink | bool | Enables blinking text |
|
||||||
|
| conceal | bool | Conceals / hides the text |
|
||||||
|
| inverse | bool | Swaps fore- & background colors |
|
||||||
|
|
||||||
|
### text
|
||||||
|
|
||||||
|
The `text` element represents a block of text.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"text": {
|
||||||
|
"bold": true,
|
||||||
|
"color": "15",
|
||||||
|
"background_color": "57"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### item
|
||||||
|
|
||||||
|
The `item` element represents an item in a list.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Markdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
- First Item
|
||||||
|
- Nested List Item
|
||||||
|
- Second Item
|
||||||
|
```
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"item": {
|
||||||
|
"prefix": "• "
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### enumeration
|
||||||
|
|
||||||
|
The `enumeration` element represents an item in an ordered list.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Markdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
1. First Item
|
||||||
|
2. Second Item
|
||||||
|
```
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"enumeration": {
|
||||||
|
"prefix": ". "
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### task
|
||||||
|
|
||||||
|
The `task` element represents a task item.
|
||||||
|
|
||||||
|
| Attribute | Value | Description |
|
||||||
|
| --------- | ------ | --------------------------- |
|
||||||
|
| ticked | string | Prefix for finished tasks |
|
||||||
|
| unticked | string | Prefix for unfinished tasks |
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Markdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
- [x] Finished Task
|
||||||
|
- [ ] Outstanding Task
|
||||||
|
```
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"task": {
|
||||||
|
"ticked": "✓ ",
|
||||||
|
"unticked": "✗ "
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### link
|
||||||
|
|
||||||
|
The `link` element represents a link.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Markdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
This is a [link](https://charm.sh).
|
||||||
|
```
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"link": {
|
||||||
|
"color": "123",
|
||||||
|
"underline": true,
|
||||||
|
"prefix": "(",
|
||||||
|
"suffix": ")"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### link_text
|
||||||
|
|
||||||
|
The `link_text` element represents the text associated with a link.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"link_text": {
|
||||||
|
"color": "123",
|
||||||
|
"bold": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### image
|
||||||
|
|
||||||
|
The `image` element represents an image.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Markdown:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
```
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"image": {
|
||||||
|
"color": "123",
|
||||||
|
"prefix": "[Image: ",
|
||||||
|
"suffix": "]"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### image_text
|
||||||
|
|
||||||
|
The `image_text` element represents the text associated with an image.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"image_text": {
|
||||||
|
"color": "8"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### code
|
||||||
|
|
||||||
|
The `code` element represents an inline code segment.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
Style:
|
||||||
|
|
||||||
|
```
|
||||||
|
"code": {
|
||||||
|
"color": "200"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### emph
|
||||||
|
|
||||||
The `emph` element represents an emphasized text.
|
The `emph` element represents an emphasized text.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the text |
|
|
||||||
| suffix | string | Printed after the text |
|
|
||||||
| styled_prefix | string | Printed before the text |
|
|
||||||
| styled_suffix | string | Printed after the text |
|
|
||||||
| color | color | Defines the default text color for the text |
|
|
||||||
| background_color | color | Defines the default background color for the text |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
Markdown:
|
||||||
|
|
||||||
@@ -689,31 +449,11 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## strong
|
### strong
|
||||||
|
|
||||||
The `strong` element represents important text.
|
The `strong` element represents important text.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------- |
|
|
||||||
| prefix | string | Printed before the text |
|
|
||||||
| suffix | string | Printed after the text |
|
|
||||||
| styled_prefix | string | Printed before the text |
|
|
||||||
| styled_suffix | string | Printed after the text |
|
|
||||||
| color | color | Defines the default text color for the text |
|
|
||||||
| background_color | color | Defines the default background color for the text |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
Markdown:
|
||||||
|
|
||||||
@@ -733,31 +473,11 @@ Output:
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
## hr
|
### hr
|
||||||
|
|
||||||
The `hr` element represents a horizontal rule.
|
The `hr` element represents a horizontal rule.
|
||||||
|
|
||||||
### Attributes
|
#### Example
|
||||||
|
|
||||||
| Attribute | Value | Description |
|
|
||||||
| ---------------- | ------ | ------------------------------------------------------------ |
|
|
||||||
| prefix | string | Printed before the horizontal rule |
|
|
||||||
| suffix | string | Printed after the horizontal rule |
|
|
||||||
| styled_prefix | string | Printed before the horizontal rule |
|
|
||||||
| styled_suffix | string | Printed after the horizontal rule |
|
|
||||||
| color | color | Defines the default text color for the horizontal rule |
|
|
||||||
| background_color | color | Defines the default background color for the horizontal rule |
|
|
||||||
| bold | bool | Increases text intensity |
|
|
||||||
| faint | bool | Decreases text intensity |
|
|
||||||
| italic | bool | Prints the text in italic |
|
|
||||||
| crossed_out | bool | Enables strikethrough as text decoration |
|
|
||||||
| underline | bool | Enables underline as text decoration |
|
|
||||||
| overlined | bool | Enables overline as text decoration |
|
|
||||||
| blink | bool | Enables blinking text |
|
|
||||||
| conceal | bool | Conceals / hides the text |
|
|
||||||
| inverse | bool | Swaps fore- & background colors |
|
|
||||||
|
|
||||||
### Example
|
|
||||||
|
|
||||||
Markdown:
|
Markdown:
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.9 KiB After Width: | Height: | Size: 1.9 KiB |
@@ -1,6 +1,5 @@
|
|||||||
{
|
{
|
||||||
"block_quote": {
|
"block_quote": {
|
||||||
"margin": 4,
|
|
||||||
"color": "200"
|
"color": "200"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.4 KiB After Width: | Height: | Size: 1.4 KiB |
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
@@ -1,6 +1,5 @@
|
|||||||
{
|
{
|
||||||
"code_block": {
|
"code_block": {
|
||||||
"margin": 4,
|
|
||||||
"color": "200",
|
"color": "200",
|
||||||
"theme": "solarized-dark"
|
"theme": "solarized-dark"
|
||||||
}
|
}
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.2 KiB After Width: | Height: | Size: 1.2 KiB |
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
@@ -1,6 +1,5 @@
|
|||||||
{
|
{
|
||||||
"list": {
|
"list": {
|
||||||
"margin": 4,
|
|
||||||
"color": "15",
|
"color": "15",
|
||||||
"background_color": "52"
|
"background_color": "52"
|
||||||
},
|
},
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.8 KiB After Width: | Height: | Size: 1.8 KiB |
|
Before Width: | Height: | Size: 340 B After Width: | Height: | Size: 340 B |
|
Before Width: | Height: | Size: 2.9 KiB After Width: | Height: | Size: 2.9 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.3 KiB |
|
Before Width: | Height: | Size: 2.3 KiB After Width: | Height: | Size: 2.1 KiB |
@@ -1,6 +1,5 @@
|
|||||||
{
|
{
|
||||||
"list": {
|
"list": {
|
||||||
"margin": 4,
|
|
||||||
"color": "15",
|
"color": "15",
|
||||||
"background_color": "52",
|
"background_color": "52",
|
||||||
"level_indent": 4
|
"level_indent": 4
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 980 B After Width: | Height: | Size: 980 B |
|
Before Width: | Height: | Size: 1.6 KiB After Width: | Height: | Size: 1.6 KiB |
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.2 KiB |
@@ -1,6 +1,5 @@
|
|||||||
{
|
{
|
||||||
"list": {
|
"list": {
|
||||||
"margin": 4,
|
|
||||||
"color": "15",
|
"color": "15",
|
||||||
"background_color": "52"
|
"background_color": "52"
|
||||||
},
|
},
|
||||||
|
|||||||