cheatsheet-styles: document paragraph styles

This commit is contained in:
Rico Sta. Cruz 2017-09-22 14:13:51 +08:00
parent 2aeeb3f677
commit 5794ccb321
No known key found for this signature in database
GPG Key ID: CAAD38AE2962619A
1 changed files with 71 additions and 12 deletions

View File

@ -26,18 +26,15 @@ Devhints uses Kramdown, and supports adding classes via Kramdown's syntax.
| `-one-column` | 1 column | | `-one-column` | 1 column |
| `-two-column` | _(default)_ 2 columns | | `-two-column` | _(default)_ 2 columns |
| `-three-column` | 3 columns | | `-three-column` | 3 columns |
| `-wide-second` | Combine with `-three-column` |
| `-left-reference` | 3 columns<br>_(short first column)_ | | `-left-reference` | 3 columns<br>_(short first column)_ |
[H2 sections](#two-columns) See: [H2 sections](#two-columns)
{: .-crosslink}
### H3 sections ### H3 sections
| `-prime` | Adds highlight | | `-prime` | Adds highlight |
[H3 sections](#h3-sections-1) See: [H3 sections](#h3-sections-1)
{: .-crosslink}
### Tables ### Tables
@ -45,18 +42,16 @@ Devhints uses Kramdown, and supports adding classes via Kramdown's syntax.
| `-left-align` | Don't right align last column | | `-left-align` | Don't right align last column |
| `-headers` | Show headers | | `-headers` | Show headers |
[Tables](#tables-1) See: [Tables](#tables-1)
{: .-crosslink}
### Code ### Code
| `-setup` | Gray background | | `-setup` | Gray background |
| `-box-chars` | Less line height<br>_for box drawing chars_ | | `-box-chars` | Less line height<br>_for box drawing chars_ |
[Code](#code-1) See: [Code](#code-1)
{: .-crosslink}
### Paragraph ### Paragraphs
| `-setup` | Gray background | | `-setup` | Gray background |
| `-crosslink` | Has arrow on the link | | `-crosslink` | Has arrow on the link |
@ -64,14 +59,15 @@ Devhints uses Kramdown, and supports adding classes via Kramdown's syntax.
Paragraphs are automatically gray, unless they're the first elements in an H3 section. Paragraphs are automatically gray, unless they're the first elements in an H3 section.
See: [Paragraphs](#paragraphs-1)
### Lists ### Lists
| `-also-see` | Lighter background | | `-also-see` | Lighter background |
| `-four-column` | 4 columns | | `-four-column` | 4 columns |
| `-six-column` | 6 columns | | `-six-column` | 6 columns |
[Lists](#lists-1) See: [Lists](#lists-1)
{: .-crosslink}
H3 sections H3 sections
----------- -----------
@ -274,6 +270,41 @@ Add `{: .-four-column}` to make large lists.
Add `{: .-also-see}`. Add `{: .-also-see}`.
## Paragraphs
{: .-three-column}
### Basic paragraphs
This is a basic section with paragraphs in it. When paragraphs are the first elements in an H3 section's body, they appear as white.
### Basic paragraphs
```
···
```
When paragraphs appear after `pre`/`table`/`ul`, they appear with a gray background.
### Preludes
Here's a prelude paragraph. Add `{: .-setup}` to make paragraphs appear with a gray background.
{: .-setup}
```
···
```
### Crosslink
Add `{: .-crosslink}` to make big loud external links:
```
···
```
[Home](/)
{: .-crosslink}
## Tables ## Tables
{: .-three-column} {: .-three-column}
@ -334,6 +365,34 @@ Add `{: .-headers}` to add headers.
··· ···
``` ```
## Left reference
{: .-left-reference}
### One
```
···
···
···
···
···
···
···
···
```
### Two
```
···
```
### Three
```
···
```
## One column ## One column
{: .-one-column} {: .-one-column}