1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
# Cheatsheet Example
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.
## H2 title
{: .col-2}
### H3 title
#### H4 title
A paragraph.
### Code
```elixir
# hello.exs
defmodule Greeter do
def greet(name) do
message = "Hello, " <> name <> "!"
IO.puts message
end
end
Greeter.greet("world")
```
### Paragraphs
Paragraphs are also supported and can quote `code`.
Paragraphs are visually distinct from one another.
### Lists
- Element 1
- Element 2
- `piece of code`
### Table
#### Date (H4 header)
| Example | Output |
| --- | --- |
| `%m/%d/%Y` | `06/05/2013` |
| `%A, %B %e, %Y` | `Sunday, June 5, 2013` |
| `%b %e %a` | `Jun 5 Sun` |
## Variants
{: .col-2}
### Adding variants
```
## H2
{: .col-2}
### H3
{: .list-6}
* example 1
* example 2
```
Variants change presentation via Markdown's inline attribute notation.
### Header variants
#### H2
| `.col-2` | two-columns |
| `.col-3` | three-columns |
| `.col-2-left` | two-columns (1/3 - 2/3) |
#### H3
| `.list-4` | four-columns for lists |
| `.list-6` | six-columns for lists |
## Code
{: .col-3}
### Code with headings
#### index.ex
```
Path.join(["~", "foo"])
"~/foo"
```
#### other.ex
```
Path.join(["foo"])
"foo"
```
Code blocks can have headings.
### Long lines
```elixir
defmodule MyTracer do
def trace({:remote_function, _meta, module, name, arity}, env) do
IO.puts "#{env.file}:#{env.line} #{inspect(module)}.#{name}/#{arity}"
:ok
end
def trace(_event, _env) do
:ok
end
end
```
Long lines show scrollbars.
### Line wrapping
```elixir
defmodule MyTracer do
def trace({:remote_function, _meta, module, name, arity}, env) do
IO.puts "#{env.file}:#{env.line} #{inspect(module)}.#{name}/#{arity}"
:ok
end
def trace(_event, _env) do
:ok
end
end
```
{: .wrap}
Add `wrap` to wrap long lines.
## Lists
{: .col-2}
### Bullet lists
- This is
- a list
- with a few items
### Ordered lists
1. First
2. Second
3. Third
An extra paragraph after the list.
### With headings and code links
#### Part 1
- `is_atom/1`
- `is_binary/1`
- `is_number/1`
#### Part 2
- `length/1`
- `elem/2`
## List columns
### Six columns
{: .list-6}
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add `{: .list-6}` after the H3 title to make large lists.
### Four columns
{: .list-4}
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add `{: .list-4}` after the H3 title to make large lists.
## Full page
The default.
## Half width
{: .width-50}
### Avoid overly long lines
#### Time
| Example | Output |
| --- | --- |
| `%H:%M` | `23:05` |
| `%I:%M %p` | `11:05 PM` |
Add `{: .width-50}` after the H2 title to use only half width.
## Column left example
{: .col-2-left}
### One
```elixir
# hello.exs
defmodule Greeter do
def greet(name) do
message = "Hello, " <> name <> "!"
IO.puts message
end
end
Greeter.greet("world")
```
### Two
```elixir
user = %{
name: "John",
city: "Melbourne"
}
```
```elixir
IO.puts "Hello, " <> user.name
```
### Three
* Yet
* Another
* List
### Four
A grid, with 1/3 - 2/3 widths.
|