View Source Cheatsheet User Guide
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.
i-m-a-h2-title-with-2-columns
I'm a H2 title with 2 columns
i-m-a-h3-title
I'm a H3 title
I'm a H4 title.
And this is a paragraph.
code
Code
# hello.exs
defmodule Greeter do
def greet(name) do
message = "Hello, " <> name <> "!"
IO.puts message
end
end
Greeter.greet("world")
paragraphs
Paragraphs
Paragraphs are also supported and can quote code
.
Several paragraphs are visually distinct.
lists
Lists
- Element 1
- Element 2
piece of code
table
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
Variants
adding-variants
Adding variants
## H2
{: .col-2}
### H3
{: .list-6}
* example 1
* example 2
Variants customize how your cheatsheet looks like via Markdown's inline attribute notation.
header-variants
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-1
Code
code-with-headings
Code with headings
index.ex
Path.join(["~", "foo"])
"~/foo"
other.ex
Path.join(["foo"])
"foo"
Code blocks can have headings.
long-lines
Long lines
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
Line wrapping
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
Add wrap
to wrap long lines.
lists-1
Lists
bullet-lists
Bullet lists
- This is
- a list
- with a few items
ordered-lists
Ordered lists
- I'm first;
- You are second;
- We are third;
Here's an extra paragraph after the list.
with-headings-and-code-links
With headings and code links
Part 1
Part 2
list-columns
List columns
six-columns
Six columns
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add {: .list-6}
after the H3 title to make large lists.
four-columns
Four columns
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add {: .list-4}
after the H3 title to make large lists.
full-page
Full page
This is the default.
half-width
Half width
i-make-tables-look-nicer
I make tables look nicer
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-reference
Column left reference
one
One
# hello.exs
defmodule Greeter do
def greet(name) do
message = "Hello, " <> name <> "!"
IO.puts message
end
end
Greeter.greet("world")
two
Two
user = %{
name: "John",
city: "Melbourne"
}
IO.puts "Hello, " <> user.name
three
Three
- Yet
- Another
- List
four
Four
I'm a grid, with 1/3 - 2/3 width.