Skip to content

Commit 07b3495

Browse files
authored
Update Cheatsheet guide wording (#1876)
1 parent 4e57d3c commit 07b3495

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

Cheatsheet.cheatmd

+16-17
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
# Cheatsheet User Guide
1+
# Cheatsheet Example
22

3-
This document is a cheatsheet on how to use cheatsheets.
4-
Cheatsheets are Markdown files with the `.cheatmd` extension. You may also check the source of this document as a reference.
3+
Cheatsheets are Markdown files with the `.cheatmd` extension which support a limited range of elements and formatting. Refer to the source of this document to see the relevant Markdown.
54

6-
## I'm a H2 title with 2 columns
5+
## H2 title
76
{: .col-2}
87

9-
### I'm a H3 title
8+
### H3 title
109

11-
#### I'm a H4 title.
10+
#### H4 title
1211

13-
And this is a paragraph.
12+
A paragraph.
1413

1514
### Code
1615

@@ -30,7 +29,7 @@ Greeter.greet("world")
3029

3130
Paragraphs are also supported and can quote `code`.
3231

33-
Several paragraphs are visually distinct.
32+
Paragraphs are visually distinct from one another.
3433

3534
### Lists
3635

@@ -64,7 +63,7 @@ Several paragraphs are visually distinct.
6463
* example 2
6564
```
6665

67-
Variants customize how your cheatsheet looks like via Markdown's inline attribute notation.
66+
Variants change presentation via Markdown's inline attribute notation.
6867

6968
### Header variants
7069

@@ -146,11 +145,11 @@ Add `wrap` to wrap long lines.
146145

147146
### Ordered lists
148147

149-
1. I'm first;
150-
2. You are second;
151-
3. We are third;
148+
1. First
149+
2. Second
150+
3. Third
152151

153-
Here's an extra paragraph after the list.
152+
An extra paragraph after the list.
154153

155154
### With headings and code links
156155

@@ -203,12 +202,12 @@ Add `{: .list-4}` after the H3 title to make large lists.
203202

204203
## Full page
205204

206-
This is the default.
205+
The default.
207206

208207
## Half width
209208
{: .width-50}
210209

211-
### I make tables look nicer
210+
### Avoid overly long lines
212211

213212
#### Time
214213

@@ -219,7 +218,7 @@ This is the default.
219218

220219
Add `{: .width-50}` after the H2 title to use only half width.
221220

222-
## Column left reference
221+
## Column left example
223222
{: .col-2-left}
224223

225224
### One
@@ -257,4 +256,4 @@ IO.puts "Hello, " <> user.name
257256

258257
### Four
259258

260-
I'm a grid, with 1/3 - 2/3 width.
259+
A grid, with 1/3 - 2/3 widths.

0 commit comments

Comments
 (0)