Improved readability of style reference

This commit is contained in:
Christian Muehlhaeuser
2019-12-07 06:10:26 +01:00
parent 35500510aa
commit f2201cad0a
+43 -45
View File
@@ -1,12 +1,10 @@
# Gold Styles # Gold Style Reference
## Elements ## document
### document
The `document` element defines the markdown's body. The `document` element defines the markdown's body.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ----------------------------------------------------- | | ---------------- | ------ | ----------------------------------------------------- |
@@ -17,7 +15,7 @@ The `document` element defines the markdown's body.
| color | color | Defines the default text color for the document | | color | color | Defines the default text color for the document |
| background_color | color | Defines the default background color for the document | | background_color | color | Defines the default background color for the document |
#### Example ### Example
``` ```
"document": { "document": {
@@ -28,11 +26,11 @@ The `document` element defines the markdown's body.
} }
``` ```
### paragraph ## paragraph
The `paragraph` element defines a paragraph in the document. The `paragraph` element defines a paragraph in the document.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | --------------------------------------------------- | | ---------------- | ------ | --------------------------------------------------- |
@@ -43,7 +41,7 @@ The `paragraph` element defines a paragraph in the document.
| color | color | Defines the default text color for paragraphs | | color | color | Defines the default text color for paragraphs |
| background_color | color | Defines the default background color for paragraphs | | background_color | color | Defines the default background color for paragraphs |
#### Example ### Example
``` ```
"paragraph": { "paragraph": {
@@ -53,17 +51,17 @@ The `paragraph` element defines a paragraph in the document.
} }
``` ```
### heading ## heading
The `heading` element defines a heading. The `heading` element defines a heading.
### h1 - h6 ## h1 - h6
The `h1` to `h6` elements define headings. `h1` defines the most important The `h1` to `h6` elements define 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 ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ------------------------------------------------- | | ---------------- | ------ | ------------------------------------------------- |
@@ -83,7 +81,7 @@ from the `heading` element.
| conceal | bool | Conceals / hides the text | | conceal | bool | Conceals / hides the text |
| inverse | bool | Swaps fore- & background colors | | inverse | bool | Swaps fore- & background colors |
#### Example ### Example
``` ```
"heading": { "heading": {
@@ -104,11 +102,11 @@ from the `heading` element.
} }
``` ```
### text ## text
The `text` element defines a block of text. The `text` element defines a block of text.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ----------------------------------------------------- | | ---------------- | ------ | ----------------------------------------------------- |
@@ -126,7 +124,7 @@ The `text` element defines a block of text.
| conceal | bool | Conceals / hides the text | | conceal | bool | Conceals / hides the text |
| inverse | bool | Swaps fore- & background colors | | inverse | bool | Swaps fore- & background colors |
#### Example ### Example
``` ```
"text": { "text": {
@@ -136,11 +134,11 @@ The `text` element defines a block of text.
} }
``` ```
### list ## list
The `list` element defines a list in the document. The `list` element defines a list in the document.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ---------------------------------------------- | | ---------------- | ------ | ---------------------------------------------- |
@@ -151,7 +149,7 @@ The `list` element defines a list in the document.
| color | color | Defines the default text color for lists | | color | color | Defines the default text color for lists |
| background_color | color | Defines the default background color for lists | | background_color | color | Defines the default background color for lists |
#### Example ### Example
``` ```
"list": { "list": {
@@ -161,11 +159,11 @@ The `list` element defines a list in the document.
} }
``` ```
### item ## item
The `item` element defines an item in lists. The `item` element defines an item in lists.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ---------------------------------------------- | | ---------------- | ------ | ---------------------------------------------- |
@@ -183,7 +181,7 @@ The `item` element defines an item in lists.
| conceal | bool | Conceals / hides the text | | conceal | bool | Conceals / hides the text |
| inverse | bool | Swaps fore- & background colors | | inverse | bool | Swaps fore- & background colors |
#### Example ### Example
``` ```
"item": { "item": {
@@ -191,11 +189,11 @@ The `item` element defines an item in lists.
} }
``` ```
### enumeration ## enumeration
The `enumeration` element defines an item in ordered lists. The `enumeration` element defines an item in ordered lists.
#### Attributes ### Attributes
| Attribute | Value | Description | | Attribute | Value | Description |
| ---------------- | ------ | ---------------------------------------------- | | ---------------- | ------ | ---------------------------------------------- |
@@ -213,7 +211,7 @@ The `enumeration` element defines an item in ordered lists.
| conceal | bool | Conceals / hides the text | | conceal | bool | Conceals / hides the text |
| inverse | bool | Swaps fore- & background colors | | inverse | bool | Swaps fore- & background colors |
#### Example ### Example
``` ```
"enumeration": { "enumeration": {
@@ -221,23 +219,23 @@ The `enumeration` element defines an item in ordered lists.
} }
``` ```
### block_quote ## block_quote
### hr ## hr
### emph ## emph
### strong ## strong
### del ## del
### link ## link
### link_text ## link_text
### image ## image
### image_text ## image_text
### html_block ## html_block
### code_block ## code_block
### softbreak ## softbreak
### hardbreak ## hardbreak
### code ## code
### html_span ## html_span
### table ## table
### table_cel ## table_cel
### table_head ## table_head
### table_body ## table_body
### table_row ## table_row