This Project provides the MD(MarkDown) language environment in GitHub. It saves my basic MD files online.
MarkDown is a very easy editing language, which appears in almost every large website, such as GitHub, and StackOverflow. Nowadays, more and more people find it very easy and simple to write files using this language, since we can spend more time focusing our attention on the content itself rather than wasting on the complicated formats. Fortunately, we can totally master it by spending only 5 minutes.
To better utilze this wonderful language, I strongly recommand a free MD editor LiteIDE, which supports the convertion from MD file to PDF file. What's more, I also overwrite a css file xp.css in the project (you can also overwrite this css file on your computer).
We also provide some tutorials to the beginners, they are,
Here are some syntax and notes you should pay attention to while writing this language.
We have three kinds of title styles, we only need add symbol #, ##, ### in front of title context.
# this is an H1
## this is an H2EXAMPLE:
We can easily implement the equation if we want to reference some words. Adding > in front of the equation.
> China is sending an envoy and delegation to North Korea - A big move, we'll see what happens!.
> - TrumpEXAMPLE:
China is sending an envoy and delegation to North Korea - A big move, we'll see what happens!.
- Trump
We use +, -, and \* to mark the listings, and all these three symbol have the same result.
+ Goldman Sachs CEO says U.K. should vote again on Brexit.
- VW has a $12B plan for electric cars in China.
* Semens is cutting 6,900 jobs.EXAMPLE:
- Goldman Sachs CEO says U.K. should vote again on Brexit.
- VW has a $12B plan for electric cars in China.
- Semens is cutting 6,900 jobs.
We have a simple way to demostrate the different code segments by inserting code into ``` {:code} ```.
```java
public static void main(String[] args){
System.out.println("Hello, MarkDown!");
}```EXAMPLE:
public static void main(String[] args){
System.out.println("Hello, MarkDown!");
}If we want to refer to a website in our text, we'd better use [:name](:links) to show the website links. Click the hyper-links we can redirect to the website.
We can visit [Baidu](http:www.baidu.com), but we cannot visit [google](http://www.google.com/) in China.EXAMPLE:
We can visit Baidu but we cannot visit google in China.
Table is a common elements in our daily word file. In MarkDown, we can implement it in the following way.
| BOOK NAME | AUTHOR | PRESS | PRICE |
| :--- | :--- | :--- | :--- |
| Intro. to GITHUB | Hongji Dazhong | Posts&Telecom | ￥39.00 |
| Intro. to MarkDown | Mingming | Wuhan Uni. | ￥50.00 |EXAMPLE:
| BOOK NAME | AUTHOR | PRESS | PRICE |
|---|---|---|---|
| Intro. to GITHUB | Hongji Dazhong | Posts&Telecom | ￥39.00 |
| Intro. to MarkDown | Mingming | Wuhan Uni. | ￥50.00 |
To rich the text we have writed or improve the word's readability, and the method of inserting a image is similar to that of inserting a link.
EXAMPLE:
The syntax of MarkDown is the same with LaTeX(such as youdao cloud and cmd Markdown), so all the symbols are list in the file docs. But we must note that some MD compilers CANNOT get the right results using LaTeX directly(such as GitHub and StackOverflow), so in that time we can only use HTML symbols to replace part of them.
α + β = γEXAMPLE:
α + β = γ
MarkDown can provide the function of checkbox when you want to emphase some points, using - [ ] or - [x]
- [ ] buy a book.
- [x] play a game.EXAMPLE:
- buy a book.
- play a game.
When we want to explain some terms or events, we can use footnote which record in the bottom of the pages. using [^ ] to keep note.
We want to reference a paper [^1] here.
[^1]: Gu, Yongfeng, J. Xuan, and T. Qian. "Automatic Reproducible Crash Detection." SATE 2016, 2016:48-53. EXAMPLE:
We want to reference a paper 1 here.
Footnotes
-
Gu, Yongfeng, J. Xuan, and T. Qian. "Automatic Reproducible Crash Detection." SATE 2016, 2016:48-53. ↩