Kickass markdown 🤩

A collection of Github markdown tricks for writing kickass READMEs, Pull Requests & Comments.
Markdown is Github's version of dress code - Make your first impression count.

Make sure to checkout Poor Man's Styleguide for all common page elements.

+ If you find this useful, please remember to ⭐ - Thanks!

What tricks can I use?

READMEs offer support for:
👉 Markdown
👉 HTML

Pull Requests & Comments offer support for:
👉 Markdown

Contribution

Missing a trick? feel free to make a contribution.

Markdown tricks

> [!CAUTION]
> this is a caution

> [!IMPORTANT]
> this is important

+ this text is highlighted in green
- this text is highlighted in red

```diff
+ this text is highlighted in green
- this text is highlighted in red
```

Some text in green! 123

```CSS
Some text in green! 123
```

Some text in blue! 123

Some text in blue with additional keyword highlighting! 123

```P4
Some text in blue! 123
```

```Mint
Some text in blue with additional keyword highlighting! 123
```

some text in light blue! 123

```robots.txt
some text in light blue! 123
```

Some text in purple! 123

Some text in purple with additional keyword highlighting! 123

```EBNF
Some text in purple! 123
```

```mupad
Some text in purple with additional keyword highlighting! 123
```

Some text in orange! 123

Some text in orange with additional keyword highlighting! 123

Some text in orange with additional keyword highlighting! 123

```Mathematica
Some text in orange! 123
```

```REXX
Some text in orange with additional keyword highlighting! 123
```

```Nix
Some text in orange with additional keyword highlighting! 123
```

some text in red!

```POV-Ray SDL
some text in red!
```

Some text in light red! 123

```RobotFramework
Some text in light red! 123
```

Some text highlighted in red! 123

```JSON
Some text highlighted in red! 123
```

HTML tricks

Monospaced text

<samp>Monospaced text</samp>

Underlined text

<ins>Underlined text</ins>

<table><tr><td>Boxed text</td></tr></table>

{
  awesome: "true"
}

<details>
<summary>Item summary with dropdown</summary>

Dropdown content (supports **markdown** ~~yay!~~)

```json
{
  awesome: "true"
}
```
</details>

Italic-bold

__*Italic-bold*__

Superscript^TM

Superscript<sup>TM</sup>

Superscript-italic^tm

Superscript-italic<sup>*tm*</sup>

Subscript_x

Subscript<sub>x</sub>

Subscript-bold_min

Subscript-bold<sub>**min**</sub>

Italic-bold-strikethrough

~~__*Italic-bold-strikethrough*__~~

Offical links

Github flavoured markdown
Github markup engine
Emoji cheat sheet

License

Licensed under MIT.