Markdown 語法介紹
點擊預覽可以看到效果:
錨點
Coding 會針對每個標題,在解析時都會添加錨點 id,如
# 錨點
會被解析成:
<h1 id="user-content-錨點">錨點</h1>
注意我們添加了一個 user-content- 的前綴,所以如果要自己添加跳轉鏈接要使用 Markdown 的形式,且鏈接要加一個 user-content- 前綴,如:
[訪問鏈接](#user-content-錨點);
引用
Markdown 標記區塊引用和 email 中用 『>』的引用方式類似,只需要在整個段落的第一行最前面加上 『>』 :
> Coding.net 爲軟件開發者提供基於雲計算技術的軟件開發平臺,包括項目管理,代碼託管,運行空間和質量控制等等。
效果圖如下:
區塊引用可以嵌套,只要根據層次加上不同數量的『>』:
> 這是第一級引用。
>
> > 這是第二級引用。
>
> 現在回到第一級引用。
效果圖如下:
引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:
> ## 這是一個標題。
> 1. 這是第一行列表項。
> 2. 這是第二行列表項。
>
> 給出一些例子代碼:
>
> return shell_exec(`echo $input | $markdown_script`);
效果圖如下:
列表
列表項目標記通常放在最左邊,項目標記後面要接一個字符的空格。
無序列表:使用星號、加號或是減號作爲列表標記
- Red
- Green
- Blue
效果圖如下:
有序列表:使用數字接着一個英文句點
1. Red
2. Green
3. Blue
效果圖如下:
如果要在列表項目內放進引用,那『>』就需要縮進:
* Coding.net有以下主要功能:
> 代碼託管平臺
> 在線運行環境
> 代碼質量監控
> 項目管理平臺
效果圖如下:
代辦列表: 表示列表是否勾選狀態(注意:[ ] 前後都要有空格)
- [ ] 不勾選
- [x] 勾選
效果圖如下:
代碼
只要把你的代碼塊包裹在 “` 之間,你就不需要通過無休止的縮進來標記代碼塊了。 在圍欄式代碼塊中,你可以指定一個可選的語言標識符,然後我們就可以爲它啓用語法着色了。 舉個例子,這樣可以爲一段 Ruby 代碼着色:
“`ruby
require ‘redcarpet’
markdown = Redcarpet.new(“Hello World!”)
puts markdown.to_html
效果圖如下:
強調
在Markdown中,可以使用 * 和 _ 來表示斜體和加粗。
斜體:
*Coding,讓開發更簡單*
_Coding,讓開發更簡單_
效果圖如下:
加粗:
**Coding,讓開發更簡單**
__Coding,讓開發更簡單__
效果圖如下:
自動鏈接
方括號顯示說明,圓括號內顯示網址, Markdown 會自動把它轉成鏈接,例如:
[超強大的雲開發平臺Coding](http://coding.net)
效果圖如下:
表格
在 Markdown 中,可以製作表格,例如:
First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell | Content Cell
Content Cell | Content Cell | Content Cell
效果圖如下:
或者也可以讓表格兩邊內容對齊,中間內容居中,例如:
First Header | Second Header | Third Header
:----------- | :-----------: | -----------:
Left | Center | Right
Left | Center | Right
效果圖如下:
分割線
在 Markdown 中,可以使用 3 個以上『-』符號製作分割線,例如:
這是分隔線上部分內容
---
這是分隔線上部分內容
效果圖如下:
圖片
Markdown 使用了類似鏈接的語法來插入圖片, 包含兩種形式: 內聯 和 引用.
內聯圖片語法如下:
![Alt text](/path/to/img.jpg) 或 ![Alt text](/path/to/img.jpg "Optional title")
也就是:
- 一個驚歎號『!』
- 接着一個方括號,裏面是圖片的替代文字
- 接着一個普通括號,裏面是圖片的網址,最後還可以用引號包住並加上 選擇性的『title’』文字。
引用圖片語法如下:
![Alt text][id]
『id』 是圖片引用的名稱. 圖片引用使用鏈接定義的相同語法:
[id]: url/to/image "Optional title attribute"
流程圖
Markdown 編輯器已支持繪製流程圖、時序圖和甘特圖。通過 mermaid 實現圖形的插入,點擊查看 更多語法詳情。
```graph graph TD; A-->B; A-->C; B-->D; C-->E; E-->F; D-->F; F-->G; ```
效果圖如下:
時序圖
```graph sequenceDiagram participant Alice participant Bob Alice->John: Hello John, how are you? loop Healthcheck John->John: Fight against hypochondria end Note right of John: Rational thoughts prevail... John-->Alice: Great! John->Bob: How about you? Bob-->John: Jolly good!```
效果圖如下:
甘特圖
```graph gantt dateFormat YYYY-MM-DD title Adding GANTT diagram functionality to mermaid section A section Completed task :done, des1, 2014-01-06,2014-01-08 Active task :active, des2, 2014-01-09, 3d Future task : des3, after des2, 5d Future task2 : des4, after des3, 5d section Critical tasks Completed task in the critical line :crit, done, 2014-01-06,24h Implement parser and jison :crit, done, after des1, 2d Create tests for parser :crit, active, 3d Future task in critical line :crit, 5d Create tests for renderer :2d Add to mermaid :1d ```
效果圖如下:
</div>
</article>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/faq/project/setting.html" title="項目常見問題">項目常見問題</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
12834</li>
</ul>
<!-- /.hkb-meta -->
</li>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/faq/project/tasks.html" title="項目任務常見問題">項目任務常見問題</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
7364</li>
</ul>
<!-- /.hkb-meta -->
</li>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/faq/project/files-2.html" title="項目文件常見問題">項目文件常見問題</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
8055</li>
</ul>
<!-- /.hkb-meta -->
</li>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/doc/project/workbench" title="工作臺及待辦事項">工作臺及待辦事項</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
175</li>
</ul>
<!-- /.hkb-meta -->
</li>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/doc/project/public-project.html" title="Coding.net 公開與私有項目融合,界面全新升級,並新增公開源代碼功能">Coding.net 公開與私有項目融合,界面全新升級,並新增公開源代碼功能</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
11961</li>
</ul>
<!-- /.hkb-meta -->
</li>
<li class="xianguanwenzhang hkb-article-list__format-standard">
<a href="https://coding.net/help/doc/project/team.html" title="團隊功能(已下線)">團隊功能(已下線)</a>
<!-- .hkb-meta -->
<ul class="hkb-meta">
<li class="hkb-meta__views">
7008</li>
</ul>
<!-- /.hkb-meta -->
</li>
</ul>
</section>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/account/index.html">用戶賬戶常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/git/git.html">Git 操作常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/git/repository.html">代碼倉庫常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/project/setting.html">項目常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/project/tasks.html">項目任務常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/project/files-2.html">項目文件常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/webide/index.html">WebIDE 常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/faq/mobile/index.html">移動端常見問題</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/doc/notice">【公告】CODING 個人版用戶權益升級和功能調整</a>
</li>
<li class="hkb-widget-article__format-standard">
<a class="hkb-widget__entry-title" href="https://coding.net/help/git/ssh-key-existed.html">添加公鑰時,提示「公鑰已存在」怎麼辦?</a>
</li>
</ul>
</section><section id="ht-kb-categories-widget-4" class="widget hkb_widget_categories clearfix"><h4 class="widget-title">幫助文檔目錄</h4><ul class="hkb_category_widget__category_list"> <li class="cat-item cat-item-3"><a href="https://coding.net/help/doc/coding-service">CODING 服務介紹</a>
jQuery(document).ready(function (){
jQuery('#topic-search-input').keypress(function (e) {
if (e.which == 13) {
var input = jQuery('#topic-search-input');
window.open("https://coding.net/search?type=topic&project=Coding-Feedback&user=coding&q=" + input.val());
return false;
}
});
})