Markdown Syntax
Total Page：16
File Type：pdf, Size：1020Kb
MARKDOWN SYNTAX Markdown is a way to style text on the web. You control the display of the document; formaing 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 # or *. HEADERS LISTS IMAGES Unordered # This is an <h1> tag  ## This is an <h2> tag * Item 1 ###### This is an <h6> tag * Item 2 Format:  * Item 2a * Item 2b EMPHASIS LINKS Ordered *This text will be italic* http://github.com - automatic! 1. Item 1 _This will also be italic_ 2. Item 2 [GitHub](http://github.com) 3. Item 3 **This text will be bold** * Item 3a __This will also be bold__ * Item 3b *You **can** combine them* BLOCKQUOTES BACKSLASH ESCAPES Markdown allows you to use backslash escapes to generate literal characters which As Grace Hopper said: would otherwise have special meaning in Markdown’s formaing syntax. > I’ve always been more interested > in the future than in the past. Markdown provides backslash escapes for \*literal asterisks\* the following characters: As Grace Hopper said: *literal asterisks* \ backslash () parentheses I've always been more interested ` backtick # hash mark in the future than in the past. * asterisk + plus sign _ underscore - minus sign (hyphen) {} curly braces . dot [] square brackets ! exclamation mark GITHUB FLAVORED MARKDOWN GitHub.com uses its own version of the Markdown syntax, GFM, that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com. USERNAME MENTIONS FENCED CODE BLOCKS Typing an @ symbol, followed by Markdown coverts text with four leading spaces into a code block; with GFM you can a username, will notify that person wrap your code with ``` to create a code block without the leading spaces. Add an to come and view the comment. optional language identifier and your code will get syntax highlighting. This is called an “@mention”, ```javascript because you’re mentioning the function test() { function test() { individual. You can also @mention console.log("look ma’, no spaces"); console.log("look ma’, no spaces"); } teams within an organization. } ``` ISSUE REFERENCES TASK LISTS TABLES Any number that refers to an Issue or You can create tables by assembling - [x] this is a complete item Pull Request will be automatically - [ ] this is an incomplete item a list of words and dividing them converted into a link. - [x] @mentions, #refs, [links](), with hyphens - (for the first row), **formatting**, and <del>tags</del> and then separating each column #1 supported github-flavored-markdown#1 - [x] list syntax required (any with a pipe | : defunkt/github-flavored-markdown#1 unordered or ordered list supported) First Header | Second Header ------------ | ------------- this is a complete item Content cell 1 | Content cell 2 EMOJI this is an incomplete item Content column 1 | Content column 2 To see a list of every image we @mentions, #refs, links, formaing, and tags supported support, check out list syntax required (any unordered or First Header Second Header www.emoji-cheat-sheet.com ordered list supported) Content cell 1 Content cell 2 Content column 1 Content column 2 GitHub supports emoji! :+1: :sparkles: :camel: :tada: :rocket: :metal: :octocat: GitHub supports emoji! .