Skip to content

Markdown Etiquete

Tables


Category 1 Category 2 Category 3
Example Example Longer example here.
Example Example Longer example here.
Example Example Longer example here.

Checklists


  • Thingy 1
  • Thingy 2
  • Thingy 3

Message Blocks (Callouts)


Info

Information here.
Alises: N/A

Todo

To-do list here.
Alises: N/A

Tip

Important info here!
Aliases: hint, important

Success

Success here!
Aliases: check, done

Question

Freqently asked questions!
Aliases: help, faq

Warning

Warning here!
Aliases: caution, attention

Failure

Failure here!
Aliases: fail, missing

Danger

Bruh!!!
Aliases: N/A

Bug

Known bugs here!
Aliases: N/A

Example

Example here!
Aliases: N/A

Quote

Quote here!
Aliases: N/A

Example:

Guess what?

[!example] Callouts can be renamed...

[!tip] ... and nested!

The following are GitHub README compatible:

Note

Highlights information that users should take into account, even when skimming.

Tip

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Diagrams


graph TD;
    A[Originator] --> B[Route 1];
    A --> C[Route 2];
    B --> D[Finish];
    C --> D;
flowchart LR

A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
gantt
    section Section
    Completed :done,    des1, 2014-01-06,2014-01-08
    Active        :active,  des2, 2014-01-07, 3d
    Parallel 1   :         des3, after des1, 1d
    Parallel 2   :         des4, after des1, 1d
    Parallel 3   :         des5, after des3, 1d
    Parallel 4   :         des6, after des4, 1d
pie
"Dogs" : 386
"Cats" : 85.9
"Rats" : 15

Code Blocks


#!/bin/bash
echo "yo momma"
# PowerShell
Get-ChildItem "C:\Windows\system32"
// Rust
fn main() {
    println!("Hello World!");
}
// C#
namespace HelloWorld
{
    class Hello {         
        static void Main(string[] args)
        {
            System.Console.WriteLine("Hello World!");
        }
    }
}

Embedding Images & Videos


URL Encoded Format

# Locally Hosted Image
![](file://<absolute_file_path_url_encoded>)

# Web Hosted Image
![](http(s)://<image_url>

File Download Support


# Download a file from a local 'downloads' directory
[link](downloads/filename.exe){:download="filename.exe"}

Info

Download RevShell.dll here.