This is a sample github readme in a table of content style. Note that the links in here would take you to the document location in the readme (the parameters used in the bracket and the 'a' tag has to match e.g for number 1, #desc and the 'a name=desc' has to be the same
- Description.
- Usage tips for text sizes.
- Text Formatting
- Links
- Images
- Tables
- Blockquotes
- LIsts
- Mentions
- Footnotes
This is a sample github readme in a table of content style
Normal text would appear like this, the br tag is a html tag that simply inserts a newline, you can use two of them to insert two new lines and yes i'm about to use one right now
italics, with asterisks
Strong emphasis, aka bold, with asterisks
bold and asteriks asterisks
Strikethrough uses two tildes. strike
Hover over the picture
As long as the bars are put in correctly, the lines do not have to align, its neater to keep them aligned though
| This | is | 4 | Columns |
|---|---|---|---|
| col 3 is | right-aligned | $1600 | test |
| col 2 is | centered | $12 | garbage |
| zebra stripes | are neat | $1 | oh well! |
| so far | the bars | are | there |
| they don't | have | to | align |
| trust me | its neater | to be | aligned |
| copy | and paste | as you | need to |
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
| 2 column | Table |
|---|---|
| col 3 is | right-aligned |
| col 2 is | centered |
| zebra stripes | are neat |
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
Alas a list
How about mentions, people mentioned would be notified, aint that cool?
@ooyinkan @[email protected]
Note this footnote uses html tags and is centered
(c) 2009, this is a product of the pathfinder team and may only be used with express permission of the team