Markdown 文件格式说明 (Markdown syntax guide)
来源:互联网 发布:淘宝产品十年事 pdf 编辑:程序博客网 时间:2024/05/19 01:14
Markdown syntax guide
By default, Stash uses Markdown as its markup language. You can use markdown in the following places:
- any pull request's descriptions or comments, or
- in README files (if they have the .md file extension).
Use Control-Shift-P or Command-Shift-P to preview your markdown.
Markdown syntax
The table below contains examples of Markdown syntax. For a full list of all the Markdown syntax, consult the official documentation on John Gruber's Daring Fireball site.
Headings
# This is an H1
## This is an H2
...
###### This is an H6
Paragraphs
Each paragraph begins on a new line. Simply press <
return
> for a new line.
For example,
like this.
You'll need an empty line between a paragraph and any following markdown construct, such as an ordered or unordered list, for that to be rendered. Like this:
* Item 1
* Item 2
Character styles
*Italic characters*
_Italic characters_
**bold characters**
__bold characters__
Unordered list
* Item 1
* Item 2
* Item 3
* Item 3a
* Item 3b
* Item 3c
Ordered list
1. Step 1
2. Step 2
3. Step 3
a. Step 3a
b. Step 3b
c. Step 3c
List in list
1. Step 1
2. Step 2
3. Step 3
* Item 3a
* Item 3b
* Item 3c
Quotes or citations
Introducing my quote:
> Neque porro quisquam est qui
> dolorem ipsum quia dolor sit amet,
> consectetur, adipisci velit...
Inline code characters
Use the backtick to refer to a `function()`.
There is a literal ``backtick (`)`` here.
Code blocks
Indent every line of the block by at least
4
spaces or
1
tab. Alternatively, you can also use
3
backtick quote marks before and after the block, like
this
:
```
Text to appear as a code block.
```
Within a code block, ampersands (&) and angle brackets (< and >)are automatically converted into HTML entities.
This is a normal paragraph:
This is a code block.
With multiple lines.
Links to external websites
This is [an example](http://www.slate.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
Images
Inline image syntax looks like this:
![Alt text](/path/to/image.jpg)
![Alt text](/path/to/image.png
"Optional title attribute"
)
![Alt text](/url/to/image.jpg)
For example:
...
![Mockup
for
feature A](http:
//monosnap.com/image/bOcxxxxLGF.png)
...
Reference image links look like this:
![Alt text][id]
where 'id' is the name of a previously defined image reference, using syntax similar to link references:
[id]: url/to/image.jpg
"Optional title attribute"
For example:
...
<--Collected image definitions-->
[MockupA]: http:
//monosnap.com/image/bOcxxxxLGF.png "Screenshot of Feature A mockup"
...
<!--Using an image reference-->
![Mockup
for
feature A][MockupA]
...
Inline HTML
An example, to add a table:
This is a regular paragraph.
<
table
>
<
tr
>
<
td
>Foo</
td
>
</
tr
>
</
table
>
This is another regular paragraph.
Note that Markdown formatting syntax is not processed within block-level HTML tags. That is, you can’t use Markdown-style *emphasis*
inside an HTML block.
See http://daringfireball.net/projects/markdown/syntax#html for more details.
README files
From Stash 1.3, you can document a project right in the repository by creating .md or .txt files. If the ReadMe has the .md extension, any Markdown it contains gets rendered straight to the screen when viewed from the file list of the repository.
- Markdown 文件格式说明 (Markdown syntax guide)
- Markdown: Syntax
- Markdown Syntax 2.0{Markdown}
- Markdown Notes02_Classical Syntax
- Markdown 编辑 Syntax Helps
- MarkDown说明
- Markdown Editor's user guide
- Markdown 语法说明 (简体中文版)
- Markdown 语法说明
- Markdown 语法说明
- MarkDown语法说明
- Markdown 语法说明 (简体中文版)
- Markdown 语法说明(简体中文版)
- Markdown 语法说明 (简体中文版)
- Markdown 语法说明
- Markdown 语法说明
- Markdown 语法说明 (简体中文版)
- Markdown 语法说明
- 如何创建一个JAR文件
- Ubuntu的窗口模式与命令行模式切换 .
- Ranorex入门指南
- Linux BFS简介
- VC生成的dll环境配置(修改名称)
- Markdown 文件格式说明 (Markdown syntax guide)
- HDU 1104 Remainder( BFS(广度优先搜索))
- 彻底解决GDI对象泄漏的问题
- Android记录4--自定义ToggleButton+用SharedPreferences保存用户配置
- HDU 3790 最短路径问题 (双重权值) dp
- js中将字符串转换成json的三种方式
- HTML URL 字符编码
- JNDI 笔记
- java.util.Date、java.sql.Date、java.sql.Time、java.sql.Timestamp区别和总结