└── README.md


/README.md:
--------------------------------------------------------------------------------
 1 | # Github Markdown Hacks
 2 | 
 3 | Showing some undocumented things you can do with Github Markdown to aid in README design.
 4 | 
 5 | ## Why?
 6 | 
 7 | The readme is probably the most important file in a github repository if you're trying
 8 | to convey the value of your project's ideas to readers.
 9 | 
10 | And of course, good design can influence a reader's comprehension and enjoyment of the content.
11 | For us to work on the design of a github readme, it would help to know what it's capable of.
12 | 
13 | ## Official
14 | 
15 | - [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/)
16 | - [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) :grin:
17 | - [More details from the official markdown renderer repo](https://github.com/github/markup)
18 | 
19 | ## Unofficial
20 | 
21 | ### Previewing locally
22 | 
23 | - [Grip - Github Readme Instant Preview](https://github.com/joeyespo/grip) - indispensable tool
24 | 
25 | ### Commonly used features
26 | 
27 | - [Shields](http://shields.io/)
28 | 
29 |   ```
30 |   <img valign="middle" src="https://img.shields.io/badge/for-example-brightgreen.svg">
31 |   ```
32 |   
33 |   <img valign="middle" src="https://img.shields.io/badge/for-example-brightgreen.svg">
34 | 
35 | ### Tags with style implications
36 | 
37 | These may break in the future since they are undocumented:
38 | 
39 | ```
40 | <samp>Monospaced text</samp>
41 | ```
42 | 
43 | <samp>Monospaced text</samp>
44 | 
45 | ```
46 | <ins>Underlined text</ins>
47 | ```
48 | 
49 | <ins>Underlined text</ins>
50 | 
51 | ```
52 | <table><tr><td>Boxed text</td></tr></table>
53 | ```
54 | 
55 | <table><tr><td>Boxed text</td></tr></table>
56 | 
57 | [You can search here for tags with other style implications](https://github.com/bryanbraun/poor-mans-styleguide)
58 | 


--------------------------------------------------------------------------------