![\"\"](\"https:\/\/i0.wp.com\/imalogic.com\/blog\/wp-content\/uploads\/2017\/05\/austin.png?resize=184%2C184&ssl=1\")
<\/a>Mark Down !<\/h1>\nMarkdown<\/a> is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like #<\/code> or *<\/code>.<\/p>\nYou can use Markdown most places around GitHub:<\/p>\n
\n- Gists<\/a><\/li>\n
- Comments in Issues and Pull Requests<\/li>\n
- Files with the
.md<\/code> or .markdown<\/code> extension<\/li>\n<\/ul>\nExamples<\/h1>\nText<\/h2>\nIt's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http:\/\/google.com)\r\n<\/pre>\nIt\u2019s very easy to make some words bold<\/strong> and other words italic<\/em> with Markdown. You can even link to Google!<\/a><\/div>\nLists<\/h2>\nSometimes you want numbered lists:\r\n\r\n1. One\r\n2. Two\r\n3. Three\r\n\r\nSometimes you want bullet points:\r\n\r\n* Start a line with a star\r\n* Profit!\r\n\r\nAlternatively,\r\n\r\n- Dashes work just as well\r\n- And if you have sub points, put two spaces before the dash or star:\r\n - Like this\r\n - And this\r\n<\/pre>\n\nSometimes you want numbered lists:<\/p>\n
\n- One<\/li>\n
- Two<\/li>\n
- Three<\/li>\n<\/ol>\n
Sometimes you want bullet points:<\/p>\n
\n- Start a line with a star<\/li>\n
- Profit!<\/li>\n<\/ul>\n
Alternatively,<\/p>\n
\n- Dashes work just as well<\/li>\n
- And if you have sub points, put two spaces before the dash or star:\n
\n- Like this<\/li>\n
- And this<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n
Images<\/h2>\nIf you want to embed images, this is how you do it:\r\n\r\n\r\n<\/pre>\n\nIf you want to embed images, this is how you do it:<\/p>\n
![\"Image](\"https:\/\/i0.wp.com\/octodex.github.com\/images\/yaktocat.png?w=810&ssl=1\")
<\/p>\n<\/div>\n
Headers & Quotes<\/h2>\n# Structured documents\r\n\r\nSometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.\r\n\r\n### This is a third-tier heading\r\n\r\nYou can use one `#` all the way up to `######` six for different heading sizes.\r\n\r\nIf you'd like to quote someone, use the > character before the line:\r\n\r\n> Coffee. The finest organic suspension ever devised... I beat the Borg with it.\r\n> - Captain Janeway\r\n<\/pre>\n\nStructured documents<\/h1>\n
Sometimes it\u2019s useful to have different levels of headings to structure your documents. Start lines with a #<\/code> to create headings. Multiple ##<\/code> in a row denote smaller heading sizes.<\/p>\nThis is a third-tier heading<\/h3>\n
You can use one #<\/code> all the way up to ######<\/code> six for different heading sizes.<\/p>\nIf you\u2019d like to quote someone, use the > character before the line:<\/p>\n
Coffee. The finest organic suspension ever devised\u2026 I beat the Borg with it. \u2013 Captain Janeway<\/p><\/blockquote>\n<\/div>\n
Code<\/span><\/h2>\nThere are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces:\r\n\r\n if (isAwesome){\r\n return true\r\n }\r\n\r\nGitHub also supports something called code fencing, which allows for multiple lines without indentation:\r\n\r\n```\r\nif (isAwesome){\r\n return true\r\n}\r\n```\r\n\r\nAnd if you'd like to use syntax highlighting, include the language:\r\n\r\n```javascript\r\nif (isAwesome){\r\n return true\r\n}\r\n```\r\n<\/pre>\n\nThere are many different ways to style code with GitHub\u2019s markdown. If you have inline code blocks, wrap them in backticks: var example = true<\/code>. If you\u2019ve got a longer block of code, you can indent with four spaces:<\/p>\nif (isAwesome){\r\n return true\r\n}\r\n<\/code><\/pre>\nGitHub also supports something called code fencing, which allows for multiple lines without indentation:<\/p>\n
if (isAwesome){\r\nreturn true\r\n}\r\n<\/code><\/pre>\nAnd if you\u2019d like to use syntax highlighting, include the language:<\/p>\n
\nif <\/span>(<\/span>isAwesome<\/span>){<\/span>\r\n return<\/span> true<\/span>\r\n}<\/span><\/pre>\n<\/div>\n<\/div>\n\n- Extras<\/li>\n<\/ul>\n
GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath \u2014 love your sweater!\r\n\r\nBut I have to admit, tasks lists are my favorite:\r\n\r\n- [x] This is a complete item\r\n- [ ] This is an incomplete item\r\n\r\nWhen you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!\r\n\r\nAnd, of course emoji! :sparkles: :camel: :boom:\r\n<\/pre>\n\nGitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath<\/a> \u2014 love your sweater!<\/p>\nBut I have to admit, tasks lists are my favorite:<\/p>\n
\n- This is a complete item<\/li>\n
- This is an incomplete item<\/li>\n<\/ul>\n
When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!<\/p>\n
And, of course emoji! ![\":sparkles:\"](\"https:\/\/i0.wp.com\/assets-cdn.github.com\/images\/icons\/emoji\/unicode\/2728.png?resize=20%2C20&ssl=1\" "\\":sparkles:\\"")
![\":camel:\"](\"https:\/\/i0.wp.com\/assets-cdn.github.com\/images\/icons\/emoji\/unicode\/1f42b.png?resize=20%2C20&ssl=1\" "\\":camel:\\"")
![\":boom:\"](\"https:\/\/i0.wp.com\/assets-cdn.github.com\/images\/icons\/emoji\/unicode\/1f4a5.png?resize=20%2C20&ssl=1\" "\\":boom:\\"")
<\/p>\n<\/div>\n
Syntax guide<\/h2>\n
Here\u2019s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.<\/p>\n
Headers<\/h3>\n\n# This is an <h1> tag<\/span>\r\n## This is an <h2> tag<\/span>\r\n###### This is an <h6> tag<\/span>\r\n<\/code><\/pre>\n<\/div>\nEmphasis<\/h3>\n\n*This text will be italic*<\/span>\r\n_This will also be italic_<\/span>\r\n\r\n**This text will be bold**<\/span>\r\n__This will also be bold__<\/span>\r\n\r\n_You **can** combine them_<\/span>\r\n<\/code><\/pre>\n<\/div>\nLists<\/h3>\nUnordered<\/h4>\n\n*<\/span> Item 1\r\n*<\/span> Item 2\r\n *<\/span> Item 2a\r\n *<\/span> Item 2b\r\n<\/code><\/pre>\n<\/div>\nOrdered<\/h4>\n\n1.<\/span> Item 1\r\n1.<\/span> Item 2\r\n1.<\/span> Item 3\r\n 1.<\/span> Item 3a\r\n 1.<\/span> Item 3b\r\n<\/code><\/pre>\n<\/div>\nImages<\/h3>\n\n<\/span>\r\nFormat: <\/span>\r\n<\/code><\/pre>\n<\/div>\nLinks<\/h3>\n\nhttp:\/\/github.com - automatic!\r\n[<\/span>GitHub<\/span>](<\/span>http:\/\/github.com<\/span>)<\/span>\r\n<\/code><\/pre>\n<\/div>\nBlockquotes<\/h3>\n\nAs Kanye West said:\r\n\r\n> We're living the future so<\/span>\r\n> the present is our past.<\/span>\r\n<\/code><\/pre>\n<\/div>\nInline code<\/h3>\n\nI think you should use an\r\n`<addr>` element here instead.\r\n<\/code><\/pre>\n<\/div>\nGitHub Flavored Markdown<\/h2>\n
GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.<\/p>\n
Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.<\/p>\n
Syntax highlighting<\/h3>\n
Here\u2019s an example of how you can use syntax highlighting with GitHub Flavored Markdown<\/a>:<\/p>\n\n```javascript\r\nfunction fancyAlert(arg) {\r\n if(arg) {\r\n $.facebox({div:'#foo'})\r\n }\r\n}\r\n```\r\n<\/code><\/pre>\n<\/div>\nYou can also simply indent your code by four spaces:<\/p>\n
\n function fancyAlert(arg) {\r\n if(arg) {\r\n $.facebox({div:'#foo'})\r\n }\r\n }\r\n<\/code><\/pre>\n<\/div>\nHere\u2019s an example of Python code without syntax highlighting:<\/p>\n
\ndef foo():\r\n if not bar:\r\n return True\r\n<\/code><\/pre>\n<\/div>\nTask Lists<\/h3>\n\n- [x] @mentions, #refs, [links](), **formatting**, and <del>tags<\/del> supported\r\n- [x] list syntax required (any unordered or ordered list supported)\r\n- [x] this is a complete item\r\n- [ ] this is an incomplete item\r\n<\/code><\/pre>\n<\/div>\nIf you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!<\/p>\n
Tables<\/h3>\n
You can create tables by assembling a list of words and dividing them with hyphens -<\/code> (for the first row), and then separating each column with a pipe |<\/code>:<\/p>\n\nFirst Header | Second Header\r\n------------ | -------------\r\nContent from cell 1 | Content from cell 2\r\nContent in the first column | Content in the second column\r\n<\/code><\/pre>\n<\/div>\nWould become:<\/p>\n
![\"\"](\"https:\/\/i0.wp.com\/imalogic.com\/blog\/wp-content\/uploads\/2017\/05\/austin.png?ssl=1\")
<\/a>Mark Down !<\/h1>\n#<\/code> or *<\/code>.<\/p>\nYou can use Markdown most places around GitHub:<\/p>\n
\n- Gists<\/a><\/li>\n
- Comments in Issues and Pull Requests<\/li>\n
- Files with the
.md<\/code> or .markdown<\/code> extension<\/li>\n<\/ul>\nExamples<\/h1>\nText<\/h2>\nIt's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http:\/\/google.com)\r\n<\/pre>\nIt\u2019s very easy to make some words bold<\/strong> and other words italic<\/em> with Markdown. You can even link to Google!<\/a><\/div>\nLists<\/h2>\nSometimes you want numbered lists:\r\n\r\n1. One\r\n2. Two\r\n3. Three\r\n\r\nSometimes you want bullet points:\r\n\r\n* Start a line with a star\r\n* Profit!\r\n\r\nAlternatively,\r\n\r\n- Dashes work just as well\r\n- And if you have sub points, put two spaces before the dash or star:\r\n - Like this\r\n - And this\r\n<\/pre>\n\nSometimes you want numbered lists:<\/p>\n
\n- One<\/li>\n
- Two<\/li>\n
- Three<\/li>\n<\/ol>\n
Sometimes you want bullet points:<\/p>\n
\n- Start a line with a star<\/li>\n
- Profit!<\/li>\n<\/ul>\n
Alternatively,<\/p>\n
\n- Dashes work just as well<\/li>\n
- And if you have sub points, put two spaces before the dash or star:\n
\n- Like this<\/li>\n
- And this<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n
Images<\/h2>\nIf you want to embed images, this is how you do it:\r\n\r\n\r\n<\/pre>\n\nIf you want to embed images, this is how you do it:<\/p>\n
<\/p>\n<\/div>\n
Headers & Quotes<\/h2>\n# Structured documents\r\n\r\nSometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.\r\n\r\n### This is a third-tier heading\r\n\r\nYou can use one `#` all the way up to `######` six for different heading sizes.\r\n\r\nIf you'd like to quote someone, use the > character before the line:\r\n\r\n> Coffee. The finest organic suspension ever devised... I beat the Borg with it.\r\n> - Captain Janeway\r\n<\/pre>\n\nStructured documents<\/h1>\n
Sometimes it\u2019s useful to have different levels of headings to structure your documents. Start lines with a #<\/code> to create headings. Multiple ##<\/code> in a row denote smaller heading sizes.<\/p>\nThis is a third-tier heading<\/h3>\n
You can use one #<\/code> all the way up to ######<\/code> six for different heading sizes.<\/p>\nIf you\u2019d like to quote someone, use the > character before the line:<\/p>\n
Coffee. The finest organic suspension ever devised\u2026 I beat the Borg with it. \u2013 Captain Janeway<\/p><\/blockquote>\n<\/div>\n
Code<\/span><\/h2>\nThere are many different ways to style code with GitHub's markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces:\r\n\r\n if (isAwesome){\r\n return true\r\n }\r\n\r\nGitHub also supports something called code fencing, which allows for multiple lines without indentation:\r\n\r\n```\r\nif (isAwesome){\r\n return true\r\n}\r\n```\r\n\r\nAnd if you'd like to use syntax highlighting, include the language:\r\n\r\n```javascript\r\nif (isAwesome){\r\n return true\r\n}\r\n```\r\n<\/pre>\n\nThere are many different ways to style code with GitHub\u2019s markdown. If you have inline code blocks, wrap them in backticks: var example = true<\/code>. If you\u2019ve got a longer block of code, you can indent with four spaces:<\/p>\nif (isAwesome){\r\n return true\r\n}\r\n<\/code><\/pre>\nGitHub also supports something called code fencing, which allows for multiple lines without indentation:<\/p>\n
if (isAwesome){\r\nreturn true\r\n}\r\n<\/code><\/pre>\nAnd if you\u2019d like to use syntax highlighting, include the language:<\/p>\n
\nif <\/span>(<\/span>isAwesome<\/span>){<\/span>\r\n return<\/span> true<\/span>\r\n}<\/span><\/pre>\n<\/div>\n<\/div>\n\n- Extras<\/li>\n<\/ul>\n
GitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath \u2014 love your sweater!\r\n\r\nBut I have to admit, tasks lists are my favorite:\r\n\r\n- [x] This is a complete item\r\n- [ ] This is an incomplete item\r\n\r\nWhen you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!\r\n\r\nAnd, of course emoji! :sparkles: :camel: :boom:\r\n<\/pre>\n\nGitHub supports many extras in Markdown that help you reference and link to people. If you ever want to direct a comment at someone, you can prefix their name with an @ symbol: Hey @kneath<\/a> \u2014 love your sweater!<\/p>\nBut I have to admit, tasks lists are my favorite:<\/p>\n
\n- This is a complete item<\/li>\n
- This is an incomplete item<\/li>\n<\/ul>\n
When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!<\/p>\n
And, of course emoji! <\/p>\n<\/div>\n
Syntax guide<\/h2>\n
Here\u2019s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.<\/p>\n
Headers<\/h3>\n\n# This is an <h1> tag<\/span>\r\n## This is an <h2> tag<\/span>\r\n###### This is an <h6> tag<\/span>\r\n<\/code><\/pre>\n<\/div>\nEmphasis<\/h3>\n\n*This text will be italic*<\/span>\r\n_This will also be italic_<\/span>\r\n\r\n**This text will be bold**<\/span>\r\n__This will also be bold__<\/span>\r\n\r\n_You **can** combine them_<\/span>\r\n<\/code><\/pre>\n<\/div>\nLists<\/h3>\nUnordered<\/h4>\n\n*<\/span> Item 1\r\n*<\/span> Item 2\r\n *<\/span> Item 2a\r\n *<\/span> Item 2b\r\n<\/code><\/pre>\n<\/div>\nOrdered<\/h4>\n\n1.<\/span> Item 1\r\n1.<\/span> Item 2\r\n1.<\/span> Item 3\r\n 1.<\/span> Item 3a\r\n 1.<\/span> Item 3b\r\n<\/code><\/pre>\n<\/div>\nImages<\/h3>\n\n<\/span>\r\nFormat: <\/span>\r\n<\/code><\/pre>\n<\/div>\nLinks<\/h3>\n\nhttp:\/\/github.com - automatic!\r\n[<\/span>GitHub<\/span>](<\/span>http:\/\/github.com<\/span>)<\/span>\r\n<\/code><\/pre>\n<\/div>\nBlockquotes<\/h3>\n\nAs Kanye West said:\r\n\r\n> We're living the future so<\/span>\r\n> the present is our past.<\/span>\r\n<\/code><\/pre>\n<\/div>\nInline code<\/h3>\n\nI think you should use an\r\n`<addr>` element here instead.\r\n<\/code><\/pre>\n<\/div>\nGitHub Flavored Markdown<\/h2>\n
GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.<\/p>\n
Note that some features of GitHub Flavored Markdown are only available in the descriptions and comments of Issues and Pull Requests. These include @mentions as well as references to SHA-1 hashes, Issues, and Pull Requests. Task Lists are also available in Gist comments and in Gist Markdown files.<\/p>\n
Syntax highlighting<\/h3>\n
Here\u2019s an example of how you can use syntax highlighting with GitHub Flavored Markdown<\/a>:<\/p>\n\n```javascript\r\nfunction fancyAlert(arg) {\r\n if(arg) {\r\n $.facebox({div:'#foo'})\r\n }\r\n}\r\n```\r\n<\/code><\/pre>\n<\/div>\nYou can also simply indent your code by four spaces:<\/p>\n
\n function fancyAlert(arg) {\r\n if(arg) {\r\n $.facebox({div:'#foo'})\r\n }\r\n }\r\n<\/code><\/pre>\n<\/div>\nHere\u2019s an example of Python code without syntax highlighting:<\/p>\n
\ndef foo():\r\n if not bar:\r\n return True\r\n<\/code><\/pre>\n<\/div>\nTask Lists<\/h3>\n\n- [x] @mentions, #refs, [links](), **formatting**, and <del>tags<\/del> supported\r\n- [x] list syntax required (any unordered or ordered list supported)\r\n- [x] this is a complete item\r\n- [ ] this is an incomplete item\r\n<\/code><\/pre>\n<\/div>\nIf you include a task list in the first comment of an Issue, you will get a handy progress indicator in your issue list. It also works in Pull Requests!<\/p>\n
Tables<\/h3>\n
You can create tables by assembling a list of words and dividing them with hyphens -<\/code> (for the first row), and then separating each column with a pipe |<\/code>:<\/p>\n\nFirst Header | Second Header\r\n------------ | -------------\r\nContent from cell 1 | Content from cell 2\r\nContent in the first column | Content in the second column\r\n<\/code><\/pre>\n<\/div>\nWould become:<\/p>\n