Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Cheatsheet guide wording #1876

Merged
merged 1 commit into from
Mar 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions Cheatsheet.cheatmd
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# Cheatsheet User Guide
# Cheatsheet Example

This document is a cheatsheet on how to use cheatsheets.
Cheatsheets are Markdown files with the `.cheatmd` extension. You may also check the source of this document as a reference.
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.

## I'm a H2 title with 2 columns
## H2 title
{: .col-2}

### I'm a H3 title
### H3 title

#### I'm a H4 title.
#### H4 title

And this is a paragraph.
A paragraph.

### Code

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

Paragraphs are also supported and can quote `code`.

Several paragraphs are visually distinct.
Paragraphs are visually distinct from one another.

### Lists

Expand Down Expand Up @@ -64,7 +63,7 @@ Several paragraphs are visually distinct.
* example 2
```

Variants customize how your cheatsheet looks like via Markdown's inline attribute notation.
Variants change presentation via Markdown's inline attribute notation.

### Header variants

Expand Down Expand Up @@ -146,11 +145,11 @@ Add `wrap` to wrap long lines.

### Ordered lists

1. I'm first;
2. You are second;
3. We are third;
1. First
2. Second
3. Third

Here's an extra paragraph after the list.
An extra paragraph after the list.

### With headings and code links

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

## Full page

This is the default.
The default.

## Half width
{: .width-50}

### I make tables look nicer
### Avoid overly long lines

#### Time

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

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

## Column left reference
## Column left example
{: .col-2-left}

### One
Expand Down Expand Up @@ -257,4 +256,4 @@ IO.puts "Hello, " <> user.name

### Four

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