Giter VIP home page Giter VIP logo

kickass-markdown's Introduction

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

+ 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>

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*__~~

Offical links

Github flavoured markdown
Github markup engine
Emoji cheat sheet

License

Licensed under MIT.

kickass-markdown's People

Contributors

olwiba avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.