Skip to content

Instantly share code, notes, and snippets.

@nturpin0
Created February 5, 2019 11:24
Show Gist options
  • Select an option

  • Save nturpin0/fbe2feb9546a8951eab105facd3e6638 to your computer and use it in GitHub Desktop.

Select an option

Save nturpin0/fbe2feb9546a8951eab105facd3e6638 to your computer and use it in GitHub Desktop.
[hasselhoff.png]: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA...

*.-------------------. ^ .---. * *| A Box |.--. __.--> | | | * *| | '--' v | | * *'-------------------' | | *

  •                   Round                                       *---(-. |                   *
    
  • .-----------------. .-------. .----------. .-------. | | | *
  • | Mixed Rounded | | | / Diagonals \ | | | | | | *
  • | & Square Corners | '--. .--' / \ |---+---| '-)-' .--------. *
  • '--+------------+-' .--. | '-------+--------' | | | | / Search / *
  • | | | | '---. | '-------' | '-+------' *
  • |<---------->| | | | v Interior | ^ *
  • ' <---' '----' .-----------. ---. .--- v | *
  • .------------------. Diag line | .-------. +---. \ / . | *
  • | if (a > b) +---. .--->| | | | | Curved line \ / / \ | *
  • | obj->fcn() | \ / | '-------' |<--' + / \ | *
  • '------------------' '--' '--+--------' .--. .--. | .-. +Done?+-' *
  • .---+-----. | ^ |\ | | /| .--+ | | \ / *
  • | | | Join | | Curved | | |/ | | \ | \ / *
  • | | +----> | '-' Vertical '--' '--' '-- '--' + .---. *
  • '---+-----' | | | 3 | *
  •                  v                             not:line    'quotes'        .-'   '---'    *
    
  •              .---+--------.            /            A || B   *bold*       |        ^      *
    
  •             |   Not a dot  |      <---+---<--    A dash--is not a line    v        |      *
    
  •              '---------+--'          /           Nor/is this.            ---              *
    

[Figure [diagram]: Diagrams can also have captions]

Code with line-like symbols is allowed in diagrams and is parsed correctly so long as you make it unambiguous:


  • .-------------------------+--+--------.
  • | --x; x->y |__| |
  • | 0 proto FILE <= |
  • | __ a | b --> foo |
  • | |__| y--; x || y a + b <--o--+
  • |||_______________________________|

Here's a diagram on the left of some text:

************** Song of Myself: 35

  • | | *
  • --+<---+-- * Would you hear of an old-time sea-fight?
  • | ^ * Would you learn who won by the light of the moon and stars?
  • v | * List to the yarn, as my grandmother's father the sailor told it to me.
  • --+--->+-- *
  • | | * Walt Whitman

If there is no leading text on the left except for whitespace, a diagram may omit the asterisks on the right side for convenience:


  • .----.
  • | |
  • '----' .------------>
  •        |
    
  •         '-------------
    

Below are some more examples of diagrams.

Diagram Examples

Lines with Decorations


  •            ________                            o        *          *   .--------------.   *
    
  • *---+--. | | o o | ^ \ / | .----------. | *
  •   |   |    '--*   -+-    |   |      v        /            \      /    | |  <------.  | |  *
    
  •   |    '----->       .---(---'  --->*<---   /      .+->*<--o----'     | |          | | |  *
    
  • <--' ^ ^ | | | | | ^ \ | '--------' | | *
  •      \/        *-----'   o     |<----->|   '-----'  |__|     v         '------------'  |  *
    
  •      /\                                                               *---------------'   *
    

Graph with Large Nodes


  •                                                                                           *
    
  • .---. .-. .-. .-. .-. *
  • | A +----->| 1 +<---->| 2 |<----+ 4 +------------------. | 8 | *
  • '---' '-' '+' '-' | '-' *
  •                       |         ^                     |                   ^               *
    
  •                       v         |                     v                   |               *
    
  •                      .-.      .-+-.        .-.      .-+-.      .-.       .+.       .---.  *
    
  •                     | 3 +---->| B |<----->| 5 +---->| C +---->| 6 +---->| 7 |<---->| D |  *
    
  •                      '-'      '---'        '-'      '---'      '-'       '-'       '---'  *
    

Graph with Small Nodes


  •             A      1      2     4                        8                                *
    
  •              *----->o<---->o<----o-----------.            o                               *
    
  •                            ^     ^            |           ^                               *
    
  •                            |     |            |           |                               *
    
  •                            v     |            v           |                               *
    
  •                            o<--->*<---->o---->*---->o---->o<---->*                        *
    
  •                           3     B      5     C     6     7      D                         *
    

Flow Chart


  •                                  .                                                        *
    
  • .---------. / \ *
  • | START | / \ .-+-------+-. ___________ *
  • '----+----' .-------. A / \ B | |COMPLEX| | / \ .-. *
  •    |        |   END   |<-----+CHOICE +----->| |       | +--->+ PREPARATION +--->| X |     *
    
  •    v         '-------'        \     /       | |PROCESS| |     \___________/      '-'      *
    
  • .---------. \ / '-+---+---+-' *
  • / INPUT / \ / *
  • '-----+---' ' *
  •    |                             ^                                                        *
    
  •    v                             |                                                        *
    
  • .-----------. .-----+-----. .-. *
  • | PROCESS +---------------->| PROCESS |<------+ X | *
  • '-----------' '-----------' '-' *

Line Ends


  •                                                                                           *
    
  • o--o *--o / / * o o o o o * * * * o o o o * * * * o o o o * * * * *
  • o--* -- v v ^ ^ | | | | | | | | \ \ \ \ \ \ \ \ / / / / / / / / *
  • o--> *--> * o / / o * v ' o * v ' o * v \ o * v \ o * v / o * v / *
  • o--- *--- *
  •                             ^ ^ ^ ^   . . . .   ^ ^ ^ ^   \ \ \ \      ^ ^ ^ ^   / / / /  *
    
  • | | * o \ \ * o | | | | | | | | \ \ \ \ \ \ \ \ / / / / / / / / *
  • v v ^ ^ v v ^ ^ o * v ' o * v ' o * v \ o * v \ o * v / o * v / *
    • o | | * o \ \ *
  •                                                                                           *
    
  • <--o <--* <--> <--- ---o ---* ---> ---- <-- o<-- -->o --> *
  •                                                                                           *
    

Tests for some tough cases:


  • +-+ \ \ | / / *
      •     \     v v v     /             *
        
  • +-+ \ .---------. / \ | / *
  •              v|         |v       vvv     *
    
  • +-+ --->| |<--- -->o<-- *
  • | | ^| |^ ^^^ *
  • +-+ / '---------' \ / | \ *
  •            /     ^ ^ ^     \             *
    
  •           /     /  |  \     \            *
    

Trees


  •                                                                                           *
    
  •      .               .                .               .--- 1          .-- 1     / 1       *
    
  •     / \              |                |           .---+            .-+         +          *
    
  •    /   \         .---+---.         .--+--.        |   '--- 2      |   '-- 2   / \ 2       *
    
  •   +     +        |       |        |       |    ---+            ---+          +            *
    
  •  / \   / \     .-+-.   .-+-.     .+.     .+.      |   .--- 3      |   .-- 3   \ / 3       *
    
  • /   \ /   \    |   |   |   |    |   |   |   |     '---+            '-+         +          *
    
  • 1   2 3   4    1   2   3   4    1   2   3   4         '--- 4          '-- 4     \ 4       *
    
  •                                                                                           *
    

Circuits


  •                             ____                      *                                   *
    
  •                            |    |_____.---.           |                                   *
    
  •                            o     _____|    )----------)-------.                           *
    
  •                           / \   |     '---'           |     __|__                         *
    
  •                          /___\  |                     |     \   /                         *
    
  •                            |    '-------------.       |      \ /                          *
    
  •          A ----------------'                  |       |       o                           *
    
  •               .-------------------.     o-----)-------'       |                           *
    
  •               |                   |___.---.   |               |___.---.                   *
    
  •          B ---*---.__.---.         ___|    )--*--.__..---.     ____)   )----- Y           *
    
  •                    __|    o----*--'   '---'    ______))   )---'   '---'                   *
    
  •          C -------'  '---'     |              |     ''---'                                *
    
  •                                |              o                                           *
    
  •                                |             / \                                          *
    
  •                                |            /___\                                         *
    
  •                                |              |                                           *
    
  •                                '--------------'                                           *
    

Gantt Chart


  •        ║ Preproduction┆       Alpha┆             RC1┆
    
  • ═══════════╬══════════════╪════════════╪════════════════╪══
  • Story ║ ▆▆▆▆▆▆▆▆ ┆ ▆┆▆▆▆ ┆
  • Concept Art║ └▆▆▆▆▆▆┆▆▆▆┐ ┆ ┆
  • Modeling ║ ┆ └▆▆▆▆▆▆▆▆┆▆▆▆▆▆▆▆ ┆
  • Rigging ║ ┆ └▆▆▆┆▆▆▆▆▆▆▆▆▆▆▆▆ ┆
  • Mechanics ║ ▆▆▆▆▆▆┆▆▆┐ ┆ ░░░░▆▆▆▆ ┆
  • Engine Code║ ▆▆▆▆▆▆▆┐ │ ┆ └────────▆┆▆▆▆▆▆▆▆▆▆▆▆▆▆ ┆
  • Game Code ║ └─┴▆┆▆▆▆▆▆▆▆▆▆▆▆▆┆▆▆▆▆ ░░░░ ▆ ┆
  •        ║              ┆            ┆    Freeze      ┆
    

Big Shapes


  •                                                                                           *
    
  •      .---------.   .   .-------.        .-------.   .---------.    .-----.      .----.    *
    
  •       \       /   / \   \       \      |         |  |         |   /       \    /      \   *
    
  •        \     /   /   \   \       \     |         |  |         |  /         \  |        |  *
    
  •         \   /   /     \   \       \    |         |  |         |  \         /  |        |  *
    
  •          \ /   /       \   \       \   |         |  |         |   \       /    \      /   *
    
  •           '   '---------'   '-------'   '-------'   '---------'    '-----'      '----'    *
    
  •                                                                                           *
    

Small Shapes


  •                           .---.                                                 __    ..  *
    
  • .--. . .-----. \ / .---. .---. ___ ___ | | | ) *
  • / \ / \ \ / .-. . ' . | | .---. .---. | | / \ | | '--' '' *
  • \ / / \ \ / | | / \ / \ '---' / / \ \ | | _/ |_| .. __ *
  • '--' '-----' ' '-' '---' /_\ '---' '---' '---' ( | || *
  •                                                                                   ''      *
    

Overlaps and Intersections


  •                                                                                           *
    
  •       .-.           .-.           .-.           .-.           .-.           .-.           *
    
  •      |   |         |   |         |   |         |   |         |   |         |   |          *
    
  •   .---------.   .--+---+--.   .--+---+--.   .--|   |--.   .--+   +--.   .------|--.       *
    
  •  |           | |           | |   |   |   | |   |   |   | |           | |   |   |   |      *
    
  •   '---------'   '--+---+--'   '--+---+--'   '--|   |--'   '--+   +--'   '--|------'       *
    
  •      |   |         |   |         |   |         |   |         |   |         |   |          *
    
  •       '-'           '-'           '-'           '-'           '-'           '-'           *
    

Big Grids


  • .----. .----. *
  • / \ / \ .-----+-----+-----. *
    •    +----+        +----.      |     |     |     |          .-----+-----+-----+-----+    *
      
  • \ / \ / \ | | | | / / / / / *
  • +----+ B +----+ + +-----+-----+-----+ +-----+-----+-----+-----+ *
  • / \ / \ / | | | | / / / / / *
    • A +----+ +----+ | | B | | +-----+-----+-----+-----+ *
  • \ / \ / \ +-----+-----+-----+ / / A / B / / *
  • '----+ +----+ + | | | | +-----+-----+-----+-----+ *
  •      \      /      \      /     |  A  |     |     |   /     /     /     /     /           *
    
  •       '----'        '----'      '-----+-----+-----'  '-----+-----+-----+-----+            *
    
  •                                                                                           *
    

Small Grids


  •   ___     ___      .---+---+---+---+---.     .---+---+---+---.  .---.   .---.             *
    
  • _/ _/ \ | | | | | | / \ / \ / \ / \ / | +---+ | *
  • / _/ _/ +---+---+---+---+---+ +---+---+---+---+ +---+ +---+ *
  • _/ b _/ \ | | | b | | | \ / \a/ \b/ \ / \ | +---+ | *
  • / a _/ _/ +---+---+---+---+---+ +---+---+---+---+ +---+ b +---+ *
  • _/ _/ \ | | a | | | | / \ / \ / \ / \ / | a +---+ | *
  •  \___/   \___/     '---+---+---+---+---'   '---+---+---+---'    '---'   '---'             *
    
  •                                                                                           *
    

Tiny Grids


  • ┌─┬─┬─┬─┬─┐ ▉▉ ▉▉ ▉▉ ⬢ ⬡ ⬡ ┌┬┬┬┬┬┬┬┬┐ ⁚⁚⁚⁚⁚⁚⁚⁚⁚⁚ ___________ +-+-+-+-+ *
  • ├─┼─┼─┼─┼─┤ ▉▉ ▉▉ ⬢ ⬢ ⬡ ⬡ ├┼┼┼┼┼┼┼┼┤ ⁚⁚⁚⁚⁚⁚⁚⁚⁚⁚ ||||| +-+-+-+-+ *
  • ├─┼─┼─┼─┼─┤ ▉▉ ▉▉ ▉▉ ⬢ ⬢ ⬢ ⬡ ⬡ ├┼┼┼┼┼┼┼┼┤ ⁚⁚⁚⁚⁚⁚⁚⁚⁚⁚ ||||| +-+-+-+-+ *
  • ├─┼─┼─┼─┼─┤ ▉▉ ▉▉ ⬡ ⬡ ⬡ ⬡ ├┼┼┼┼┼┼┼┼┤ ⁚⁚⁚⁚⁚⁚⁚⁚⁚⁚ ||||| +-+-+-+-+ *
  • └─┴─┴─┴─┴─┘ ▉▉ ▉▉ ▉▉ ⬡ ⬡ ⬡ └┴┴┴┴┴┴┴┴┘ ⁚⁚⁚⁚⁚⁚⁚⁚⁚⁚ ||||| +-+-+-+-+ *

Dot Grids


  •                                                                                           *
    
  • o o o o o * * * * * * * o o * o o o * * * o o o · * · · · · · · *
  • o o o o o * * * * * o o o o * o o o o * * * * * o * * · * * · · · · · · *
  • o o o o o * * * * * o * o o o o o o o o * * * * * o o o o o · o · · o · · * * · *
  • o o o o o * * * * * o * o o o o o o o * * * * o * o o · · · · o · · * · *
  • o o o o o * * * * * * * * * o o o o * * * o * o · · · · · · · * *
  •                                                                                           *
    

Unicode in Diagram


  •                       ↖ ↗   ✶ ✹ ✩ ⓵             ⎲                ░░▒▒▓▓▉▉ ▚▚  ▢ ▢ ⬚ ⬚ ⊕   
    
  • ▲ ◀━━━━━━━▶ ↙ ↘ ➊ ❶ ➀ ① ➕ ➖ ➗ ❌ ⎳ ╲ ╱ ░░▒▒▓▓▉▉ ▚▚ ▢ ▢ ⬚ ⬚ ⊜
  • ┃ ╭╌╌╌╌╌╌╌╮ ╔═══════╗ ┏━━━━━━━┓ ┏╍╍╍╍╍╍╍┓ ╲ ╱ ░░▒▒▓▓▉▉ ▚▚ ⬣ ⬣ ⎔ ⎔ ⊗
  • ┃ ╎ ╎ ║ ║ ┃ ┃ ╏ ╏ ⎛ ⎧ ⎡ ╳ ░░▒▒▓▓▉▉ ▚▚ ⬣ ⬣ ⎔ ⎔ ⊘
  • ┃ ╎ ╎ ║ ║ ┃ ┃ ╏ ╏⋮ ⎜ ⎨ ⎢ ╱ ╲ ░░▒▒▓▓▉▉ ▚▚ ◯ ◯ ⏣ ⏣ ⊙
  • ▼ ╰╌╌╌╌╌╌╌╯ ╚═══════╝ ┗━━━━━━━┛ ⋱ ┗╍╍╍╍╍╍╍┛⋮ ⎝ ⎩ ⎣╱ ╲ ░░▒▒▓▓▉▉ ▚▚ ◯ ◯ ⏣ ⏣ ⊛
  •                                      ⋱         ⋮                   ◢▉▉◣                  
    
  • ∑xᵢ 𝚺xᵢ ∫t²dt ⋱ ⋮ ◥▉▉◤

Simple Plot Diagram


  •    ▲
    
  • Uin ┊ .------------------------
  •    ┊   |                        
    
  •    ┊   |                        
    
  •    *---'┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄▶
    
  • Udc▲                          
    
  • Udc_OK ┊ .---------------------
  •    ┊     /  :                   
    
  •    ┊    /   :                   
    
  •    *---'┄┄┄┄:┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄▶
    
  •             :<----->:           
    
  •    ▲          500ms :           
    
  •    ┊                :           
    

*Cpu.Qon ┊┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄.-----------

  •    ┊                |  Inactive 
    
  •    ┊    Active      |  
    
  •    *----------------'┄┄┄┄┄┄┄┄┄┄┄▶
    

Graphics Diagram


  •                                                                         .                 *
    
  • 0 3 P * Eye / ^ / *
  • *-------*      +y                    \                +)          \   /  Reflection       *
    
  • 1 /| 2 /| ^ \ \ \ v *
  • ------- | | v0 \ v3 --------*-------- *
  • | |4 | |7 | ◄╮ --------- *
  • | -----|- ⤹ +-----> +x / v X \ .-.<-------- o *
  • |/ |/ / ⤴ / o \ | / | Refraction / \ *
  • ------- v / \ +-' / \ *
  • 5 6 +z v1 ------------------ v2 | o-----o *
  •                                                           v                               *
    

Annotated Table Diagram


  •   ┏━━━━┳━━━━┳   ┳━━━━┓
    
  •   ┃ A₁ ┃ A₂ ┃ ⋯ ┃ Aⱼ ┃ <--- Basis 
    
  •   ┡━━━━╇━━━━╇   ╇━━━━┩
    
  •   │ 16 │  4 │ ⋯ │  9 │
    
  • ⎧ ├────┼────┼   ┼────┤
    
  • │ │  1 │ -2 │ ⋯ │ 10 │
    
  • Xᵢ ⎨ ├────┼────┼ ┼────┤
  • │ │  8 │ 52 │ ⋯ │  0 │
    
  • ⎩ ├────┼────┼   ┼────┤
    
  •   │ 14 │  0 │ ⋯ │ -1 │
    
  •   └────┴────┴   ┴────┘
    

Icon Diagram


  •                                  .-.                           .--------.                 *
    
  •                               .-+   |                         |          |                *
    
  •                           .--+       '--.                     |'--------'|                *
    
  •                          |  Server Cloud |<------------------>| Database |                *
    
  •                           '-------------'                     |          |                *
    
  •                               ^      ^                         '--------'                 *
    
  •                Internet       |      |                              ^                     *
    
  •      .------------------------'      '-------------.                |                     *
    
  •      |                                             |                v                     *
    
  •      v                                             v              .------.       .------. *
    
  • .--------.      WiFi     .--------.  Bluetooth  .-----.          / #  # /|      / #  # /| *
    
  • |        |<------------->|        |<---------->|       |        +------+/| LAN +------+/| *
    
  • |Windows |               |  OS X  |            |  iOS  |        |      +/|<--->|      +/| *
    
  • +--------+               +--------+            |       |        |Ubuntu+/|     |Ubuntu+/| *
    
  • /// ____ \\ /// ____ \\ | o | | +/ | +/ *
  • '------------' '------------' '-----' '------' '------' *
  •  Laptop 1                 Laptop 2              Tablet 1         Dedicated Server Rack    *
    

Schedule Lists

Schedule lists contain titles that begin with a valid date. After the title, arbitrary indented content appears, including lists, text, and equations:

Tuesday Feb 16, 2016: Project Launch
 - Create specifications
 - Initialize revision control system
 
Friday Feb 19, 2016: Build Milestone
 - Build system fully functional
 - Placeholder unit tests committed
                  ⋮

(Monday Feb 29, 2016): Office Closed

If the schedule is sufficiently long and dense, then a calendar preview is shown before it. Entries in parenthesis with no further details are formatted with a more subtle style.

Formatted schedule lists look like:

Tuesday Feb 16, 2016: Project Launch

  • Create specifications
  • Initialize revision control system

Friday Feb 19, 2016: Build Milestone

  • Build system fully functional
  • Placeholder unit tests committed

Plan for weekend overtime if we miss this milestone

Wednesday Feb 24, 2016: Site Visit Whole team vistits client. Dress appropriately.

Friday Feb 26, 2016: Demo Milestone

  • Internal demonstrations for management
  • QA reports due

(Monday Feb 29, 2016): Office Closed

Tuesday Mar 1, 2016: Code Freeze

  • Commit final features before this date
  • Only priority 1 fixes with issue tracking numbers after this point

Monday Mar 7, 2016: Beta

Wednesday Mar 16, 2016: Gold

Dates can be in any unambigous format that includes a month, day, and four-digit year between 1000 and 2999, such as:

  • 2001-03-01
  • 1 Apr. 1999
  • 4-07-1976
  • February 16, 2016
  • 2020 Jan. 15
  • May 15th, 1982

The US date format MM/DD/YYYY is not supported because it is ambiguous. The date may include the name of a day of the week (e.g., Sunday). It will be replaced with the correct day.

When months are given by name, they must match the localization settings.

github:

  • completed
    • subtask
  • uncompleted

streamlined: [x] completed [x] subtask [ ] uncompleted


github:
- [x] completed
  - [x] subtask
- [ ] uncompleted

streamlined:
[x] completed
  [x] subtask
[ ] uncompleted
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment