Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Olwiba/Kickass-markdown
A collection of Github markdown tricks for writing kickass READMEs, Pull Requests & Comments.
https://github.com/Olwiba/Kickass-markdown
comments github hacks kickass markdown pull-requests readme tricks
Last synced: about 11 hours ago
JSON representation
A collection of Github markdown tricks for writing kickass READMEs, Pull Requests & Comments.
- Host: GitHub
- URL: https://github.com/Olwiba/Kickass-markdown
- Owner: Olwiba
- License: mit
- Created: 2022-10-21T00:41:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-21T05:35:07.000Z (about 2 years ago)
- Last Synced: 2024-10-27T21:40:05.695Z (12 days ago)
- Topics: comments, github, hacks, kickass, markdown, pull-requests, readme, tricks
- Homepage:
- Size: 6.84 KB
- Stars: 363
- Watchers: 4
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - Olwiba/Kickass-markdown - A collection of Github markdown tricks for writing kickass READMEs, Pull Requests & Comments. (Others)
README
# 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](https://github.com/bryanbraun/poor-mans-styleguide#readme) for all common page elements.
```diff
+ If you find this useful, please remember to ⭐ - Thanks!
```
## What tricks can I use?
READMEs offer support for:
👉 [Markdown](#markdown-tricks)
👉 [HTML](#html-tricks)
Pull Requests & Comments offer support for:
👉 [Markdown](#markdown-tricks)
## Contribution
Missing a trick? feel free to make a [contribution](https://github.com/Olwiba/Kickass-markdown/edit/main/README.md).
## Markdown tricks
```diff
+ 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
```
---
```CSS
Some text in green! 123
```
```CSS
Some text in green! 123
```
---
```P4
Some text in blue! 123
```
```Mint
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
```
---
```robots.txt
some text in light blue! 123
```
```robots.txt
some text in light blue! 123
```
---
```EBNF
Some text in purple! 123
```
```mupad
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
```
---
```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
```
```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
```
---
```POV-Ray SDL
some text in red!
```
```POV-Ray SDL
some text in red!
```
---
```RobotFramework
Some text in light red! 123
```
```RobotFramework
Some text in light red! 123
```
---
```JSON
Some text highlighted in red! 123
```
```JSON
Some text highlighted in red! 123
```
## HTML tricks
Monospaced text
```
Monospaced text
```
---
Underlined text
```
Underlined text
```
---
Boxed text
```
Boxed text
```
---
Item summary with dropdown
Dropdown content (supports **markdown** ~~yay!~~)
```json
{
awesome: "true"
}
```
<details>
<summary>Item summary with dropdown</summary>
Dropdown content (supports **markdown** ~~yay!~~)
```json
{
awesome: "true"
}
```
</details>
---
__*Italic-bold*__
```
__*Italic-bold*__
```
---
SuperscriptTM
```
SuperscriptTM
```
---
Superscript-italic*tm*
```
Superscript-italic*tm*
```
---
Subscriptx
```
Subscriptx
```
---
Subscript-bold**min**
```
Subscript-bold**min**
```
---
~~__*Italic-bold-strikethrough*__~~
```
~~__*Italic-bold-strikethrough*__~~
```
## Offical links
[Github flavoured markdown](https://docs.github.com/en/get-started/writing-on-github)
[Github markup engine](https://github.com/github/markup)
[Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)
## License
Licensed under [MIT](https://github.com/Olwiba/Kickass-markdown/blob/main/LICENSE).