From 07b34957883cbc88aeb65c42a6d9abdf9446bbef Mon Sep 17 00:00:00 2001 From: David Oliver Date: Wed, 6 Mar 2024 17:20:55 +0100 Subject: [PATCH] Update Cheatsheet guide wording (#1876) --- Cheatsheet.cheatmd | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/Cheatsheet.cheatmd b/Cheatsheet.cheatmd index 49a715c88..e3c0c0241 100644 --- a/Cheatsheet.cheatmd +++ b/Cheatsheet.cheatmd @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -257,4 +256,4 @@ IO.puts "Hello, " <> user.name ### Four -I'm a grid, with 1/3 - 2/3 width. \ No newline at end of file +A grid, with 1/3 - 2/3 widths.