Files
reference/source/_posts/quickref.md
T
2022-11-20 18:14:08 +08:00

16 KiB

title, date, icon, background, tags, categories, intro
title date icon background tags categories intro
QuickRef 2020-11-25 18:28:43 icon-star bg-red-600
guide
reference
Other
This is a reference of styles that you can use on quickref cheatsheets!

Variants

H2 section

- -
.cols-1 one column (default)
.cols-2
.cols-3 three column
...
.cols-6

See: H2 section

H3 section

- -
.primary Primary section
.secondary Secondary section

Span n columns

- -
.col-span-1
...
.col-span-12

Span n rows

- -
.row-span-1
...
.row-span-12

See: H3 section

Tables

- -
.bold-first Bold first column
.plus-first Plus first column
.show-header Show headers
.left-text Align the last column left
.no-wrap Don't wrap text
.shortcuts Shortcut keys style

See: Tables

Lists

- -
.marker-none No marker
.marker-round Round style
.marker-timeline Timeline style

Layout

- -
.cols-1 one column (default)
.cols-2
.cols-3 three column
...
.cols-6

See: Lists

Code

- -
.wrap Enables line-wrapping

See: Code

Paragraphs

- -
.link-arrow Pretty links with arrows

See: Paragraphs

Global

- -
.hidden Hide an element

How to add variants

H2 section
----------

### H3 section {.col-span-2}

### primary section {.primary}

[Home](/) {.link-arrow}

QuickRefs uses markdown-it-attrs, and supports adding classes via its syntax.

H2 Layout Variants

H2 Overview

- -
{.cols-1} one-column layout
{.cols-2} two-column layout
{.cols-3} three-column layout (default)
...
{.cols-6} six-column layout

  • H2 section contains multiple cards (aka H3 section)
  • Use {.cols-n} to specify h2 as a n-column layout
  • Click the preview button below to focus on the h2 section

Preview {.link-arrow}

.cols-1

# One Column Example {.cols-1}
╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈1╮ 
┆                                     ┆ 
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯ 
╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈2╮
┆                                     ┆
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯

↓ Source Code

One Column Example {.cols-1}
----------

### 1
### 2

Preview {.link-arrow}

.cols-2

# Two Columns Example
╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈1╮ ╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈2╮
┆                 ┆ ┆                 ┆
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈3╮
┆                 ┆
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯

↓ Source Code

Two Columns Example {.cols-2}
----------

### 1
### 2
### 3

Preview {.link-arrow}

.cols-3 (default)

# Default
╭┈┈┈┈┈┈┈┈┈1╮ ╭┈┈┈┈┈┈┈┈┈2╮ ╭┈┈┈┈┈┈┈┈┈3╮
┆          ┆ ┆          ┆ ┆          ┆
╰┈┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈┈4╮ 
┆          ┆ 
╰┈┈┈┈┈┈┈┈┈┈╯ 

↓ Source Code

Default
----------

### 1
### 2
### 3
### 4

H3 Layout Variants

H3 Overview

Specifies the number of columns the card spans

- -
{.col-span-1}
{.col-span-2} Example
...
.col-span-6}

Specifies the number of rows the card spans

- -
{.row-span-1}
{.row-span-2} Example
...
{.row-span-6}

Emphasize card (aka H3 Section)

- -
{.primary} Red titles
{.secondary} Yellow titles, The current card is a secondary card

.col-span-2

The fifth card spans two columns

╭┈┈┈┈┈┈┈┈1╮ ╭┈┈┈┈┈┈┈┈2╮ ╭┈┈┈┈┈┈┈┈3╮
┆         ┆ ┆         ┆ ┆         ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈4╮ ╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈5╮
┆         ┆ ┆                     ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯

### 1
### 2
### 3
### 4
### 5 {.col-span-2}

The second card spans two columns

╭┈┈┈┈┈┈┈┈1╮ ╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈2╮
┆         ┆ ┆                     ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈3╮ ╭┈┈┈┈┈┈┈┈4╮ ╭┈┈┈┈┈┈┈┈5╮
┆         ┆ ┆         ┆ ┆         ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯

### 1
### 2 {.col-span-2}
### 3
### 4
### 5

The fourth card spans two columns

╭┈┈┈┈┈┈┈┈1╮ ╭┈┈┈┈┈┈┈┈2╮ ╭┈┈┈┈┈┈┈┈3╮
┆         ┆ ┆         ┆ ┆         ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈4╮ ╭┈┈┈┈┈┈┈┈5╮ 
┆                     ┆ ┆         ┆ 
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ 

### 1
### 2
### 3
### 4 {.col-span-2}
### 5

.row-span-2

The first card spans two rows

╭┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮
┆ 1      ┆ ┆ 2       ┆ ┆ 3       ┆
┆        ┆ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯
┆        ┆ ╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮
┆        ┆ ┆ 4       ┆ ┆ 5       ┆
╰┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯

### 1 {.row-span-2}
### 2
### 3
### 4
### 5

The second card spans two rows

╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮
┆ 1       ┆ ┆ 2      ┆ ┆ 3       ┆
╰┈┈┈┈┈┈┈┈┈╯ ┆        ┆ ╰┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈┈╮ ┆        ┆ ╭┈┈┈┈┈┈┈┈┈╮
┆ 4       ┆ ┆        ┆ ┆ 5       ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯

### 1
### 2 {.row-span-2}
### 3
### 4
### 5

The third card spans two rows

╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈╮ 
┆ 1       ┆ ┆ 2       ┆ ┆ 3      ┆ 
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ┆        ┆ 
╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮ ┆        ┆ 
┆ 4       ┆ ┆ 5       ┆ ┆        ┆ 
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈╯ 

### 1
### 2
### 3 {.row-span-2}
### 4
### 5

.col-span-2 .row-span-2

╭┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮
┆ 1                   ┆ ┆ 2       ┆
┆                     ┆ ╰┈┈┈┈┈┈┈┈┈╯
┆                     ┆ ╭┈┈┈┈┈┈┈┈┈╮
┆                     ┆ ┆ 3       ┆
╰┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯
╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮ ╭┈┈┈┈┈┈┈┈┈╮
┆ 4       ┆ ┆ 5       ┆ ┆ 6       ┆
╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯ ╰┈┈┈┈┈┈┈┈┈╯

↓ Source Code

### 1 {.col-span-2 .row-span-2}
### 2
### 3
### 4
### 5

Spans rows and columns at the same time

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.

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.

Long lines

function createNode(nodeName: string, options: { key: string }) {
  return true
}

Long lines will have scrollbars.

Paragraphs

Basic paragraphs

The text that appears in the header

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.

Description

...

A gray background

···

When paragraphs appear after pre/table/ul, they appear with a gray background.

Add {.link-arrow} to make big loud external links:

···
···
···

Home {.link-arrow}

Tables Variants

Table Overview

- -
{.shortcuts} Render shortcut key style
{.show-header} Show the header of the table

Basic table

Expression Description
$1 … $9 Parameter 1 ... 9
$0 Name of the script itself
$1 First argument
${10} Positional parameter 10
$# Number of arguments

↓ Source Code

| Expression  | Description               |
|-------------|---------------------------|
| `$1` … `$9` | Parameter 1 ... 9         |
| `$0`        | Name of the script itself |
| `$1`        | First argument            |
| `${10}`     | Positional parameter 10   |
| `$#`        | Number of arguments       |

.show-header

Expression Description
$1 … $9 Parameter 1 ... 9
$0 Name of the script itself
$1 First argument
${10} Positional parameter 10
{.show-header}

↓ Source Code

| Expression  | Description               |
|-------------|---------------------------|
| `$1` … `$9` | Parameter 1 ... 9         |
| `$0`        | Name of the script itself |
| `$1`        | First argument            |
| `${10}`     | Positional parameter 10   |
{.show-header}

.shortcuts

- -
Ctrl N New File
Ctrl S Save
{.shortcuts}

↓ Source Code

| -           | -          |
|-------------|------------|
| `Ctrl` `N`  | New File   |
| `Ctrl` `S`  | Save       |
{.shortcuts}

Lists Variants

List Overview

List columns

- -
{.cols-1} one column (default)
{.cols-2} two columns
...
{.cols-12}

List markers

- -
{.marker-none} Marker is not set
{.marker-timeline} Marker style like timeline
{.marker-round} Round marker

One Column (Default)

  • Share quick reference.
  • cheat sheet for developers.
  • Contributed by open source angels.
  • Manage your code snippets.

↓ Source Code

- Share quick reference.
- cheat sheet for developers.
- Contributed by open source angels.
- Manage your code snippets.

.cols-3

  • Share
  • Quick
  • Reference
  • And
  • Cheat Sheet
  • For
  • Developers {.cols-3}

↓ Source Code

- Share
- Quick
- Reference
- And
- Cheat Sheet
- For
- Developers
{.cols-3}

.marker-timeline

  • Renamed to new_name
    $ git branch -m <new_name>
    
  • Push and reset
    $ git push origin -u <new_name>
    
  • Delete remote branch
    $ git push origin --delete <old>
    

{.marker-timeline}

↓ Source Code

- **Renamed** to `new_name`
    ```shell script
    $ git branch -m <new_name>
    ```
- **Push** and reset
    ```shell script
    $ git push origin -u <new_name>
    ```
- **Delete** remote branch
    ```shell script
    $ git push origin --delete <old>
    ```
{.marker-timeline}

.marker-none

  • Share
  • Quick
  • Reference
  • And
  • Cheat Sheet {.cols-2 .marker-none}

↓ Source Code

- Share
- Quick
- Reference
- And
- Cheat Sheet
{.cols-2 .marker-none}

.marker-round

  • Share
  • Quick
  • Reference {.marker-round}

↓ Source Code

- Share
- Quick
- Reference
{.marker-round}

H2 section

One

···

Two

···

Three

···

Four

···

Five

···

H3 section

row-span-2

···

col-span-2

···

Primary section

···
···

Add {.primary} to make the title red.

Secondary section

···

Add {.secondary} to make the title yellow.

col-span-3

···

Supported

Each section can have the following children:

White

  • pre
  • ul
  • table

Gray

  • p
  • h4

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.