Created
October 18, 2013 10:00
-
-
Save clijiac/7039323 to your computer and use it in GitHub Desktop.
Markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hi All: | |
In this mail .i want to share something about the **Markdown** . | |
Markdown is a lightweight markup language.Allowing people “to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML)” | |
* In our company.because we use mail to communicate with each other.especially the review issue,when we reply to review comments.use markdown may be a good choice to make our mail more clearly. | |
* we can use markdown to generate html code and paste into the email.we mainly will use the syntax is the Blockquotes (>) and code ('). | |
---------- | |
## Blockquotes ## | |
Blockquotes are created by adding an angle bracket.use `>`. For example: | |
``` | |
> "This entire paragraph of text will be enclosed in an HTML blockquote element. | |
Blockquote elements are reflowable. You may arbitrarily | |
wrap the text to your liking, and it will all be parsed | |
into a single blockquote element." | |
``` | |
The above would translate into the following HTML: | |
``` | |
<blockquote><p>This entire paragraph of text will be enclosed in an HTML blockquote element. Blockquote | |
elements are reflowable. You may arbitrarily wrap the text to your liking, and it will all | |
be parsed into a single blockquote element.</p></blockquote> | |
``` | |
looks like this | |
> "This entire paragraph of text will be enclosed in an HTML blockquote element. | |
Blockquote elements are reflowable. You may arbitrarily | |
wrap the text to your liking, and it will all be parsed | |
into a single blockquote element." | |
we can easily use in reply to review comment points. | |
## Code ## | |
you can either surround inline code with backticks (\`) or indent several lines of code by at least four spaces. | |
Backticks can be used in a sentence to represent code. | |
``` | |
Some text with `some code` inside | |
``` | |
This translates into: | |
``` | |
Some text with <code>some code</code> inside | |
``` | |
Multiline code or longer pieces of code should be indented by four spaces. | |
``` | |
line 1 of code | |
line 2 of code | |
line 3 of code | |
``` | |
This translates into: | |
``` | |
<pre> | |
<code> | |
line 1 of code | |
line 2 of code | |
line 3 of code | |
</code> | |
</pre> | |
``` | |
Looks like | |
line 1 of code | |
line 2 of code | |
line 3 of code | |
some tools can make syntax highlighting of source code.such as http://benweet.github.io/stackedit/# | |
like | |
<pre> | |
<code> | |
```c#<br/> | |
protected override ScopedTable[] GetScopedTables() | |
{ | |
string table = typeof(FitnessEventMember).ToString(); | |
// we probably don't want to support None, which is mainly for compatibility | |
return new ScopedTable[] | |
{ | |
new ScopedTable(table, this.MemberId, DBEntityScopes.Member), | |
new ScopedTable(table, string.Empty, DBEntityScopes.None) | |
}; | |
}<br/> | |
``` | |
</code> | |
</pre> | |
will be translate to | |
```c# | |
protected override ScopedTable[] GetScopedTables() | |
{ | |
string table = typeof(FitnessEventMember).ToString(); | |
// we probably don't want to support None, which is mainly for compatibility | |
return new ScopedTable[] | |
{ | |
new ScopedTable(table, this.MemberId, DBEntityScopes.Member), | |
new ScopedTable(table, string.Empty, DBEntityScopes.None) | |
}; | |
} | |
``` | |
## Reference ## | |
You can also find some resource in following links | |
[http://qingbo.net/picky/502-markdown-syntax.html](http://qingbo.net/picky/502-markdown-syntax.html ) (中文) | |
[http://www.ituring.com.cn/article/775](http://www.ituring.com.cn/article/775) (中文) | |
## Tools ## | |
[http://markable.in/editor/](http://markable.in/editor/) | |
[http://benweet.github.io/stackedit/#](http://benweet.github.io/stackedit/#) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment