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!READMEs offer support for:
👉 Markdown
👉 HTML
Pull Requests & Comments offer support for:
👉 Markdown
Missing a trick? feel free to make a contribution.
+ 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! 123Some 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! 123Some 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! 123Some text in orange with additional keyword highlighting! 123Some 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 ```
Monospaced text
<samp>Monospaced text</samp>
Underlined text
<ins>Underlined text</ins>
| Boxed text |
<table><tr><td>Boxed text</td></tr></table>
Item summary with dropdown
Dropdown content (supports markdown yay!)
{
awesome: "true"
}<details>
<summary>Item summary with dropdown</summary>
Dropdown content (supports **markdown** ~~yay!~~)
```json
{
awesome: "true"
}
```
</details>
Italic-bold
__*Italic-bold*__
SuperscriptTM
Superscript<sup>TM</sup>
Superscript-italictm
Superscript-italic<sup>*tm*</sup>
Subscriptx
Subscript<sub>x</sub>
Subscript-boldmin
Subscript-bold<sub>**min**</sub>
Italic-bold-strikethrough
~~__*Italic-bold-strikethrough*__~~
Github flavoured markdown
Github markup engine
Emoji cheat sheet
Licensed under MIT.