Skip to content

Latest commit

 

History

History
68 lines (60 loc) · 2.12 KB

GitHubMarkdown.md

File metadata and controls

68 lines (60 loc) · 2.12 KB

Markdown- Markdown Cheatsheet

Source: GitHub Hacknight - WWCode Barcelona

Table Of Contents: 🚀

1. GitHub Markdown

  • GitHub uses its own version of the Markdown syntax.
  • It provides an additional set of usefull features, that make it easier to work with content on github.com:

GOALS:

  • a. USERNAME @MENTIONS
  • b. ISSUE REFERENCES
  • c. TASK LISTS
  • d. FENCED CODE BLOCKS
  • e. TABLES
  • f. EMOJI

a. USERNAME @MENTIONS

  • Type a @ symbol followe by a username to notify the person to view the comment.
  • This is called an "@mention", as you are mentioning an individual.
  • You can also "@mention" teams within an organization.

b. ISSUE REFERENCES

Any number refering to an Issue or Pull Request is automatically converted into a link:

  • #1
  • defunkt#1
  • defunkt/github-flavored-markdown#1

c. TASK LISTS

  • @mentions, #refs, links,]]formatting]], and tags supported.
  • list syntax required (any unordered list or ordered list supported).
  • this is a complete item.
  • [] this is an incomplete item.

d. FENCED CODE BLOCKS

  • You can create a code block with ```to create a code block without the leading spaces.
javascript
function test(){
console.log("look ma`,  no spaces");
}
  • Add an optional language identifier and your code with get syntax highlighting.
function test (){
console.log("look ma`, no spaces");
}

e. TABLES

In GitHub you can create a table by

  • assembling a list of words
  • divide them with hyphens (-) for first row
  • separate each column with a pipe I
| Tables   |      Are      |  Cool |
|----------|:-------------:|------:|
| col 1 is |  left-aligned | $1600 |
| col 2 is |    centered   |   $12 |
| col 3 is | right-aligned |    $1 |

f. EMOJI

GitHub supports emoji! :+1: :sparkles: :camel: :tada: :rocket: :metal: :octocat:

Resources