Intro
Variants
H2 sections
-one-column |
ย |
-two-column |
(default) |
-three-column |
ย |
-left-reference |
3 columns (short first column) |
See: H2 sections
H3 sections
-prime |
Highlight |
See: H3 sections
Tables
-bold-first |
Bold first column |
-headers |
Show headers |
-left-align |
Donโt right align last column |
-mute-em |
Lower opacity for italics |
-no-wrap |
Donโt wrap text |
-shortcuts |
Shortcut keys |
See: Tables
Code
-box-chars |
Less line height for box drawing chars |
-setup |
Gray background |
-wrap |
Enables line-wrapping |
See: Code
Paragraphs
-setup |
Gray background |
-crosslink |
Has arrow on the link |
See: Paragraphs
Lists
-also-see |
Lighter background |
-four-column |
ย |
-six-column |
ย |
See: Lists
Adding variants
## Section
{: .-two-column}
Devhints uses Kramdown, and supports adding classes via Kramdownโs syntax.
H3 sections
Supported
Each section can have the following children:
White
preultable
Gray
ph4
Prime section
This is a section with {: .-prime}. Notice the fancy highlight! Great for โgetting startedโ kind of snippets.
H3 section
Every box is an H3 section. The box will encompass everything inside the body of the H3.
This is a basic section with paragraphs in it.
Code
Basic code
here.is(() => {
some.code()
})
here.is.some.more()
Code blocks can be placed one after the other.
See: Cheatsheets
Code with headings
index.js
here.is(() => {
some.code()
})
other.js
here.is.some.more()
Code blocks can have headings.
Highlighted lines
app.start(() => {
const port = app.server.port
console.log(`Started at ${port}`)
})
Add {: data-line="3"} to add line highlights.
Multiple highlights
app.start(() => {
const port = app.server.port
console.log(`Started at ${port}`)
})
Add {: data-line="2,3"} to add multiple line highlights.
Setup blocks
import React from 'react'
class Hello extends React.Component {
render () {
return <span>Hello</span>
}
}
Add {: .-setup} to a pre or table or ul.
Long lines
function createNode(nodeName: string, options: { key: string }) {
return true
}
Long lines will have scrollbars.
Line wrapping
<script>(function(d,s){if(window.Promise&&[].includes&&Object.assign&&window.Map)return;var js,sc=d.getElementsByTagName(s)[0];js=d.createElement(s);js.src='https://cdn.polyfill.io/v2/polyfill.min.js';sc.parentNode.insertBefore(js, sc);}(document,'script'))</script>
Add -wrap to wrap long lines.
Lists
Lists
- This is
- a list
- with a few items
Hereโs an extra paragraph after the list.
Lists with headings
Part 1
createElement()componentDidMount()componentWillUnmount()
Part 2
shouldComponentUpdate()componentWillReceiveProps()
Hereโs an extra paragraph after the list.
List columns
Six columns
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add {: .-six-column} to make large lists.
Four columns
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
- Eleven
Add {: .-four-column} to make large lists.
Also see
- One
- Two
- Three
- Four
- Five
- Six
- Seven
- Eight
- Nine
- Ten
Add {: .-also-see}.
Paragraphs
Basic paragraphs
This is a basic section with paragraphs in it. When paragraphs are the first elements in an H3 sectionโs body, they appear as white.
Basic paragraphs
ยทยทยท
When paragraphs appear after pre/table/ul, they appear with a gray background.
Preludes
Hereโs a prelude paragraph. Add {: .-setup} to make paragraphs appear with a gray background.
ยทยทยท
Crosslink
Tables
Basic table
Date
| Example | Output |
|---|---|
%m/%d/%Y |
06/05/2013 |
%A, %B %e, %Y |
Sunday, June 5, 2013 |
%b %e %a |
Jun 5 Sun |
Time
| Example | Output |
|---|---|
%H:%M |
23:05 |
%I:%M %p |
11:05 PM |
This is a basic table with h4โs.
Shortcuts
V |
Vector |
P |
Pencil |
T |
Text |
L |
Line |
R |
Rectangle |
O |
Oval |
U |
Rounded |
Add {: .-shortcuts} to tables.
With headers
| Prefix | Example | What |
|---|---|---|
// |
//hr[@class='edge'] |
Anywhere |
./ |
./a |
Relative |
/ |
/html/body/div |
Root |
Add {: .-headers} to add headers.
Two columns
One
ยทยทยท
Two
ยทยทยท
Left reference
One
ยทยทยท
ยทยทยท
ยทยทยท
ยทยทยท
ยทยทยท
ยทยทยท
ยทยทยท
ยทยทยท
Two
ยทยทยท
Three
ยทยทยท
One column
One
ยทยทยท
0 Comments for this cheatsheet. Write yours!