Skip to content

zeddit/github_flavored_markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 

Repository files navigation

Git Markdown Training

a training for github flavored markdown

Basic Elements

# Header 1

## Header 2

### Header 3

##### Header 4

###### Header 5
####### Header 6

Text

**bold** bold

_italic_ italic

Link

[link](README.md) link

Image

![](img.jpg)

![](img.jpg)

*caption*

caption

using table for caption display.

|![](img.jpg)|
|:---:|
|*caption*|
caption

Lists

* unordered list 1
  * unordered sublist 1
  * unordered sublist 2
  * unordered sublist 3
* unordered list 2
* unordered list 3
  • unordered list 1
    • unordered sublist 1
    • unordered sublist 2
    • unordered sublist 3
  • unordered list 2
  • unordered list 3
1. ordered list 1
1. ordered list 2
1. ordered list 3
  1. ordered list 1
  2. ordered list 2
  3. ordered list 3

Quotes

> This is a quote
> \- zeddit

This is a quote - zeddit

Codes

In line codes: `print "zeddit"`

In line codes: print "zeddit"

block codes:(using indentation for escaping three backticks in code block)

```typing language for highlight use
#This is code block;
print "zeddit"
```

block codes:

#This is code block;
print "zeddit"

Additional Elements

Task Lists

- [x] task completed 1
- [x] task completed 2
- [ ] task 1
- [ ] task 2
  • task completed 1
  • task completed 2
  • task 1
  • task 2

Tables

Header 1 | Header 2 | Header 3
:--- | :---: | ---:
left aligned | center aligned | right aligned 

at least three hyphens needed to divide headers and contents.

Header 1 Header 2 Header 3
left aligned center aligned right aligned

Table of Content

Using github's automatically generated section links, e.g. #Tables to create ToC.

* [Tables](#tables)
* [Task lists](#task-lists)
* [Basic Elements](#basic-elements)

Extented Elements

Latex Supported

![](http://latex.codecogs.com/gif.latex?e^{ix}=cosx+isinx)

Notice! Escaping back slash by \\

some UMLs

TODO:

About

a training for markdown

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published