Github Flavour Markdown

H6 tháng 4, 2024

Github Flavored Markdown (GFMD)

Text Writing

It is easy to write in GFMD. Just write simply like text and use the below simple "tagging" to mark the text and you are good to go!

To specify a paragraph, leave 2 spaces at the end of the line

Headings

# Sample H1

## Sample H2

### Sample H3

#### Sample H4

##### Sample H5

will produce

Sample H1

Sample H2

Sample H3

Sample H4

Sample H5

Horizontal Rules

Horizontal rule is created using --- on a line by itself.


Coding - Block

will produce

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!"
  end
end

# Create a new object
g = Greeter.new("world")

# Output "Hello World!"
g.salute

Note: You can specify the different syntax highlighting based on the coding language eg. ruby, sh (for shell), php, etc
Note: You must leave a blank line before the \```

Coding - In-line

You can produce inline-code by using only one ` to enclose the code:

This is some code: `echo something`

will produce

This is some code: echo something


Text Formatting

Bold Text is done using **Bold Text**
Italic Text is done using *Italic Text*


  • GFMD will automatically detect URL and convert them to links like this http://www.futureworkz.com
  • To specify a link on a text, do this:
This is [an example](http://example.com/ "Title") inline link. [This link](http://example.net/) has no title attribute.

Escape sequence

You can escape using \ eg. \`


Creating list

Adding a - will change it into a list:

- Item 1 + Item 1.1 + Item 1.2 - Item 2 - Item 3

will produce

  • Item 1
    • Item 1.1
    • Item 1.2
  • Item 2
  • Item 3

Quoting

You can create a quote using >:

Table and Definition list

IDNameRank
1Tom Preston-WernerAwesome
2Albert EinsteinNearly as awesome

Adding Image

![Branching Concepts](http://git-scm.com/figures/18333fig0319-tn.png "Branching Map")