小書匠語法使用手冊

小書匠語法使用手冊

小書匠

語法

MARKDOWN

幫助

經常使用語法

標題

1 這是 H1 一級標題 

---

2 ------ 

---

3 這是 H2 二級標題 

---

4 ====== 

---

5 # 這是 H1 一級標題 

---

6 ## 這是 H2 二級標題 

---

7 ### 這是 H3 三級標題 

---

8 #### 這是 H4 四級標題 

---

9 ##### 這是 H5 五級標題 

---

10 ###### 這是 H6 六級標題 

---

11 

---

快捷鍵: [ctrl + h]

列表

無序列表

1 * 項目1 

---

2 * 子項目1.1 

---

3 * 子項目1.2 

---

4 * 子項目1.2.1 

---

5 * 項目2 

---

6 * 項目3 

---

7 

---

8 + 項目1 

---

9 + 子項目1.1 

---

10 + 子項目1.2 

---

11 + 子項目1.2.1 

---

12 + 項目2 

---

13 + 項目3 

---

14 

---

15 - 項目1 

---

16 - 子項目1.1 

---

17 - 子項目1.2 

---

18 - 子項目1.2.1 

---

19 - 項目2 

---

20 - 項目3 

---

21 

---

快捷鍵: [ctrl + u]

有序列表

1 1. 項目1 

---

2 2. 項目2 

---

3 3. 項目3 

---

4 1. 項目3.1 

---

5 2. 項目3.2 

---

6 

---

7 1. 項目1 

---

8 1. 項目2 

---

9 1. 項目3 

---

10 1. 項目3.1 

---

11 1. 項目3.2 

---

12 

---

有序列表起始編號

1 58. 項目5 

---

2 2. 項目6 

---

3 

---

快捷鍵: [ctrl + o]

連接

1[ 連接名稱]( 連接地址) 

---

2[ 連接名稱][ 1] 

---

3[1] : 連接地址 

---

4 

---

圖片

1 

---

2![ 名稱][ 1] 

---

3[1] : 連接地址 

---

4 

---

文字格式

1 **這是文字粗體格式** 

---

2 

---

3 __這是文字粗體格式__ 

---

4 

---

5 *這是文字斜體格式* 

---

6 

---

7 _這是文字斜體格式_ 

---

8 

---

引用

1 > 第一行引用文字 

---

2 > 第二行引用文字 

---

3 

---

水平線

1 *** 

---

2 

---

GFM擴展語法

表格

1First Header | Second Header 

---

2 ------------- | ------------- 

---

3Content Cell | Content Cell 

---

4Content Cell | Content Cell 

---

5 

---

加強型表格

1|First Header | Second Header || 

---

2|First Header | Second Header | Third Header| 

---

3|------------- | -------------|-------------| 

---

4表身1Content Cell | Merge Content Cell|| 

---

5Content Cell | Content Cell| Content Cell| 

---

6 

---

7表身2Content Cell | Merge Content Cell|| 

---

8Content Cell | Content Cell| Content Cell| 

---

9[表格標題] 

---

10 

---

代碼

行內代碼

1 `var x = "hello world"` 

---

2 

---

塊代碼

1 ```javascript 

---

2var a = "hello world"; 

---

3var b = "good luck"; 

---

4 ``` 

---

5 

---

自動轉換成超連接

系統將自動根據內容，將地址轉換成超連接格式

1http://markdown.xiaoshujiang.com 

---

2 

---

HTML

1 <div class="hey">Hello world </div> 

---

2 

---

支持的html標籤

刪除線

1~~在文字上添加刪除線~~ 

---

2 

---

擴展語法

目錄

1[toc] 

---

2 

---

擴展的文字格式

1++插入的文字++ 

---

2 

---

3==被記號的文字== 

---

4 

---

5上角文字: 19^th^ 

---

6 

---

7下角文字: H~2~O 

---

8 

---

印刷字替換

系統將自動替換下列文字，轉換成排版系統使用的符號

1(c) (C) (r) (R) (tm) (TM) (p) (P) +- 

---

2 

---

縮寫定義

1The HTML specification 

---

2is maintained by the W3C. 

---

3*[HTML]: Hyper Text Markup Language 

---

4*[W3C]: World Wide Web Consortium 

---

5 

---

待辦事項

1[ ] 未完成事項 

---

2[-] 未完成事項 

---

3[x] 完成事項 

---

4[X] 完成事項 

---

5 

---

腳註

1腳註[^1x] 

---

2[ ^1x]: 腳註的用法 

---

3 

---

定義

1蘋果 

---

2: 一種水果 

---

3: 一種品牌，計算機，手持設備 

---

4桔子 

---

5: 一種水果 

---

6 

---

公式

行內公式

1這是行內公式 `!$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. $` 

---

2 

---

塊公式

1 ```mathjax! 

---

2$$\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.$$ 

---

3 ``` 

---

4 

---

流程圖 (語法)

1 ```flow 

---

2st=>start: 開始 

---

3e=>end: 結束 

---

4op=>operation: 操做步驟 

---

5cond=>condition: 是 或者 否? 

---

6 

---

7st->op->cond 

---

8cond(yes)->e 

---

9cond(no)->op 

---

10 ``` 

---

11 

---

序列圖 (語法)

1 ```sequence 

---

2小明->小李: 你好 小李, 最近怎麼樣? 

---

3Note right of 小李: 小李想了想 

---

4小李-->小明: 仍是老樣子 

---

5 ``` 

---

6 

---

小書匠編輯器擴展語法

塊代碼內文字格式

塊代碼高亮標記

1 ```javascript 

---

2var hello = 'hello world' 

---

3 ``` 

---

4 

---

塊代碼刪除線

1 ```javascript 

---

2var hello = 'hello world' 

---

3 ``` 

---

4 

---

塊代碼加粗

1 ```javascript 

---

2var hello = 'hello world' 

---

3 ``` 

---

4 

---

塊代碼下橫線

1 ```javascript 

---

2var hello = 'hello world' 

---

3 ``` 

---

4 

---

小書匠編輯器提供了附件管理功能，用戶可經過./對附件的引用，好比圖片./jiangzhu.jpg。附件的上傳需經過工具欄的插入圖片ctrl+g，插入視頻ctrl+shift+v，插入音頻ctrl+shift+a，插入附件ctrl+shift+t功能鍵進行操做。

視頻

1%[ 名稱]( 連接地址) 

---

2%[ 名稱][ 1] 

---

3[1] : 連接地址 

---

4 

---

音頻

1~[ 名稱]( 連接地址) 

---

2~[ 名稱][ 1] 

---

3[1] : 連接地址 

---

4 

---

附件

1=[ 名稱]( 連接地址) 

---

2=[ 名稱][ 1] 

---

3[1] : 連接地址 

---

4 

---

元數據

元數據必須放置在每篇文章的開頭才能生效。若是文章裏有元數據時，系統將自動以元數據的標題爲準，用戶經過文章信息的維護界面修改的標題及tags將會被覆蓋掉。

1 --- 

---

2title: 小書匠語法使用手冊 

---

3tags: 小書匠,語法,MARKDOWN,幫助 

---

4 ---  

---

5 

---

mermaid流程圖，序列圖，甘特圖（mermaid語法）

1 ```mermaid! 

---

2graph TD; 

---

3A-->B; 

---

4A-->C; 

---

5B-->D; 

---

6C-->D; 

---

7 ``` 

---

8 

---

統計圖 （統計圖語法）

數據格式爲：{"data": [], "options":{}}
系統使用jquery.parseJSON()函數進行解析，所以代碼必須符合該函數的要求才能正常解析。

1 ```plot! 

---

2{ 

---

3"data": [ [[0, 0], [1, 1]] ], 

---

4"options": { "yaxis": { "max": 1 } } 

---

5} 

---

6 ``` 

---

7 

---

自定義class

1 ## 自定義class {class名稱} 

---

2 

---

經過自定義的class名稱後，你就能夠在每篇文章的自定義css裏添加本身想要的樣式了．

cjk強調

1 _這裏將顯示帶有襯線字體效果的中文作爲強調_ 

---

2 

---

cjk註音標示

1{須要被註音標示的內容}(註音標示) 

---

2{須要被註音標示的內容}[編號] 

---

3[ 編號]: 註音標示 

---

4 

---

居中顯示文字

1->居中顯示的文字 <- 

---

2  

---

對齊顯示文字

1:>居左顯示的文字 <- 

---

2 ->居右顯示的文字 <: 

---

3 :>兩端對齊顯示的文字 <: 

---

4 ->居中顯示的文字 <- 

---

5  

---

注： 該語法與center語法衝突，兩種語法同時開啓時，align語法將覆蓋center語法。

---

示例

• 經常使用語法
  • 標題
  • 列表
    • 無序列表
    • 有序列表
    • 有序列表起始編號
  • 連接
  • 圖片
  • 文字格式
  • 引用
  • 水平線
• GFM擴展語法
  • 表格
  • 加強型表格
  • 代碼
    • 行內代碼
    • 塊代碼
  • 自動轉換成超連接
  • HTML
  • 刪除線
• 擴展語法
  • 目錄
  • 擴展的文字格式
  • 印刷字替換
  • 縮寫定義
  • 待辦事項
  • 腳註
  • 定義
  • 公式
    • 行內公式
    • 塊公式
    • 流程圖 (語法)
    • 序列圖 (語法)
• 小書匠編輯器擴展語法
  • 塊代碼內文字格式
    • 塊代碼高亮標記
    • 塊代碼刪除線
    • 塊代碼加粗
    • 塊代碼下橫線
  • 視頻
  • 音頻
  • 附件
  • 元數據
  • mermaid流程圖，序列圖，甘特圖（mermaid語法）
  • 統計圖 （統計圖語法）
  • 自定義class
  • cjk強調
  • cjk註音標示
  • 居中顯示文字
  • 對齊顯示文字
• 示例
• 這是 H1 一s級標題
  • 這是 H2 二級標題
    • 這是 H3 三級標題
      • 這是 H4 四級標題
        • 這是 H5 五級標題
          • 這是 H6 六級標題
    • 視頻
    • 音頻
    • 附件
    • 待辦事項
    • 縮寫定義
    • 印刷字替換
    • html代碼
    • 流程圖 (語法)
    • 序列圖 (語法)
    • 腳註[1]
    • 表格Tables
    • 定義
    • 文字格式
    • 無序列表
    • 有序列表
    • 有序列表起始編號
    • 圖片
    • 引用
    • 水平線
    • 代碼
      • 行內代碼
      • 塊代碼
  • 塊代碼內文字格式
    • 塊代碼高亮標記
    • 塊代碼刪除線
    • 塊代碼加粗
    • 塊代碼下橫線
    • 顯示行號
    • 高亮指定行
    • 顯示行號並從指定行數計數
    • 禁用顯示行號
    • 公式
      • 行內公式
      • 塊公式
      • 帶編號的公式
    • 統計圖
    • mermaid流程圖，序列圖，甘特圖
      • 流程圖
      • 序列圖
      • 甘特圖
    • PPT語法
    • emoji表情語法
    • 自定義class
      • 自定義class用例
    • cjk強調
      • 這裏將顯示中文襯線字體作爲強調樣式
    • cjk註音標示
    • 居中顯示
    • 文字對齊
    • 加強型表格

http://www.github.com/suziwen/markdownxiaoshujiang
http://www.xiaoshujiang.com

這是 H1 一s級標題

這是 H2 二級標題

這是 H3 三級標題

這是 H4 四級標題

這是 H5 五級標題

這是 H6 六級標題

視頻

音頻

附件

jianzhu.jpg 1024.01KB

待辦事項

未完成事項

未完成事項

完成事項

完成事項

縮寫定義

The HTML specification
is maintained by the W3C.

印刷字替換

© © ® ® ™ ™ § § ±

html代碼

html代碼

流程圖 (語法)

序列圖 (語法)

腳註^[1]

表格Tables

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

定義

蘋果

一種水果

一種品牌，計算機，手持設備

桔子

一種水果

文字格式

這是文字粗體格式

這是文字粗體格式

這是文字斜體格式

這是文字斜體格式

在文字上添加刪除線

插入的文字

被記號的文字

上角文字: 19^th

下角文字: H₂O

無序列表

• 項目1

  • 子項目1.1

  • 子項目1.2

    • 子項目1.2.1

• 項目2

• 項目3

有序列表

1. 項目1

2. 項目2

3. 項目3

   1. 項目3.1

   2. 項目3.2

有序列表起始編號

58. 項目5

59. 項目6

圖片

連接

連接名稱

引用

第一行引用文字
第二行引用文字

水平線

---

代碼

行內代碼

var x = "hello world"

塊代碼

1 /** 

---

2 * @author John Smith <john.smith@example.com> 

---

3 * @version 1.0 

---

4 */ 

---

5 package l2f.gameserver.model; 

---

6 

---

7 import java.util.ArrayList; 

---

8 

---

9 public abstract class L2Character { 

---

10 public abstract class L2Character extends L2Object { 

---

11 public static final Short ABNORMAL_EFFECT_BLEEDING = 0x0_0_0_1; // not sure 

---

12 

---

13 public void moveTo(int x, int y, int z) { 

---

14 _ai = null; 

---

15 _log.warning( "Should not be called"); 

---

16 if ( 1 > 5) { 

---

17 return; 

---

18 } 

---

19 } 

---

20 

---

21 /** Task of AI notification */ 

---

22 @SuppressWarnings( { "nls", "unqualified-field-access", "boxing" }) 

---

23 public class NotifyAITask implements Runnable { 

---

24 private final CtrlEvent _ evt; 

---

25  

---

26 List<String> mList = new ArrayList<String>() 

---

27 

---

28 public void run() { 

---

29 try { 

---

30 getAI().notifyEvent( _evt, _evt.class, null); 

---

31 } catch (Throwable t) { 

---

32 t.printStackTrace(); 

---

33 } 

---

34 } 

---

35 } 

---

36} 

---

37 

---

塊代碼內文字格式

塊代碼高亮標記

1 var he llo = 'hello world' 

---

2 

---

塊代碼刪除線

1 var he llo = 'hello world' 

---

2 

---

塊代碼加粗

1 var he llo = 'hello world' 

---

2 

---

塊代碼下橫線

1 var he llo = 'hello world' 

---

2 

---

顯示行號

1 var x = 1; 

---

2 var z = 'str'; 

---

3 

---

高亮指定行

1 var x = 1; 

---

2 var y = 2; 

---

3 var z = 3; 

---

4 var u = 4; 

---

5 var w = 5; 

---

6 var a = 6; 

---

7 

---

顯示行號並從指定行數計數

10 var x = 1; 

---

11 

---

禁用顯示行號

var x = 1;

公式

行內公式

這是行內公式

塊公式

帶編號的公式

統計圖

mermaid流程圖，序列圖，甘特圖

流程圖

序列圖

甘特圖

PPT語法

使用

1 

---

2 - --- 

---

3  

---

4 

---

做爲一個水平頁分割線，注意在----先後都須要空一行

使用

1 

---

2 - - 

---

3  

---

4 

---

做爲一個垂直頁分割線, 注意在--先後都須要空一行

經過以下形式

1 <!-- .element: class="fragment" data-fragment-index="1" --> 

---

2  

---

能夠實現fragment顯示效果

注：　在演示文檔模式下，toc和腳註語法將失效.

emoji表情語法

自定義class

自定義class用例

你能夠經過查看生成的html代碼裏，在h4裏找到名爲green的class名稱．

cjk強調

這裏將顯示中文襯線字體作爲強調樣式

cjk註音標示

小(xiao)書(shu)匠(jiang)

居中顯示

居中顯示的 文字(wenzi)

文字對齊

居左顯示的文字

居右顯示的文字

兩端對齊顯示的文字

居中顯示的文字

加強型表格

表格標題

First Header	Second Header
First Header	Second Header	Third Header
表身1Content Cell	Merge Content Cell
Content Cell	Content Cell	Content Cell
表身2Content Cell	Merge Content Cell
Content Cell	Content Cell	Content Cell

---

1. 腳註的用法 ↩