Browse Source

继续编辑基础语法文档

zry 8 years ago
parent
commit
a2bb462a97
1 changed files with 152 additions and 16 deletions
  1. 152 16
      BasicSyntax/BasicSytax.md

+ 152 - 16
BasicSyntax/BasicSytax.md

@@ -26,7 +26,48 @@
 
 ### 缩进
 
-缩进指在行首出现的一个或连续几个空白符,在ZumDown中,缩进通常会被忽略。如果您想在文中利用缩进产生层级视觉效果,请使用原本在Markdown中代表区块引用的\>号,在ZumDown中它将代表一个制表符的缩进。关于缩进和区块引用的详细说明请看本文档的《与Markdown不兼容的特性》部分。
+缩进指在行首出现的一个或连续几个空白符,在ZumDown中,缩进通常会被忽略。如果您想在文中利用缩进产生层级视觉效果,请使用->号(必须从行首开始使用),在ZumDown中它将代表一个制表符的缩进。关于缩进和区块引用的详细说明请看本文档的《与Markdown不兼容的特性》部分。
+
+### Superblock
+
+ZumDown提供的一种可扩展高级块级元素,通常情况下使用一对三个\`号包围,第一行写Superblock的控制语句:
+
+```code:zumdown
+    ```Superblock控制语句
+    块内容
+    ```
+```
+
+Superblock控制语句用于指定该Superblock的类型和基本样式。如果该类型不含样式参数,直接写类型,例如注释:
+
+```code:zumdown
+    ```comment
+    这是一些注释
+    ```
+```
+
+如果该类型含有样式参数,则格式为`类型:样式参数`,多个参数用逗号隔开:
+
+```code:zumdown
+    ```Superblock类型:样式参数1,样式参数2,样式参数3,...
+    块内容
+    ```
+```
+
+例如代码区块:
+
+```code:zumdown
+    ```code:python
+    def foo():
+        return bar()
+    ```
+```
+
+由于Superblock是可扩展的,所以不同的渲染器,或者在不同的使用场合,可能存在具体的区别,因为渲染器的开发者或者使用了某个渲染器的网站会自己定义一些类型的Superblock。
+关于具体的Superblock用法,可以参考本文档的以下部分:
+
+* 基本Superblock功能
+* 在swzry.com旗下网站支持的Superblock内容
 
 ## Markdown已有的样式功能
 
@@ -52,6 +93,17 @@
 
 ```code:zumdown
 
+    大标题
+    =============
+
+    二级标题
+    -------------
+
+```
+
+```panel
+显示效果
+
 大标题
 =============
 
@@ -60,18 +112,21 @@
 
 ```
 
-显示效果:
-
->大标题
->=============
->
->二级标题
->-------------
-
 类 atx 形式:
 
 ```code:zumdown
 
+    # 这是 大标题
+
+    ## 这是 二级标题
+
+    ###### 这是 六级标题
+
+```
+
+```panel
+显示效果
+
 # 这是 大标题
 
 ## 这是 二级标题
@@ -79,27 +134,108 @@
 ###### 这是 六级标题
 
 ```
+### 无序列表与有序列表
 
-显示效果:
+#### 无序列表
+
+使用星号、加号或是减号作为列表标记
+
+```code:zumdown
+
+    * 博丽灵梦
+    * 雾雨魔理沙
+    * 东风谷早苗
+
+    + 东方红魔乡
+    + 东方妖妖梦
+    + 东方萃梦想
+    + 东方永夜抄
+
+    - 博丽神社
+    - 红魔馆
+    - 雾之湖
+
+```
+
+```panel
+显示效果
+
+* 博丽灵梦
+* 雾雨魔理沙
+* 东风谷早苗
+
++ 东方红魔乡
++ 东方妖妖梦
++ 东方萃梦想
++ 东方永夜抄
+
+- 博丽神社
+- 红魔馆
+- 雾之湖
+
+```
+
+#### 有序列表
+
+```code:zumdown
+    1. 一面道中
+    2. 一面BOSS
+    3. 二面道中
+    4. 二面BOSS
+```
+
+```panel
+显示效果
+
+1. 一面道中
+2. 一面BOSS
+3. 二面道中
+4. 二面BOSS
+
+```
+
+```alert:info
+**注意:** 列表标记上使用的数字并不会影响输出的 HTML 结果
+```
+
+例如:
+
+```code:zumdown
+    9. 一面道中
+    9. 一面BOSS
+    9. 二面道中
+    9. 二面BOSS
+```
+
+```panel
+显示效果
+
+9. 一面道中
+9. 一面BOSS
+9. 二面道中
+9. 二面BOSS
+
+```
+
+```alert:info
+所以,如果想偷懒懒,您可以完全不用在意数字的正确性。
+```
 
-># 这是 大标题
->
->## 这是 二级标题
->
->###### 这是 六级标题
 
 
 ## 与Markdown不兼容的特性
 
 值得注意的是,ZumDown虽然兼容大部分Markdown语法语义,但并不是完全兼容,这里特意将不能兼容的部分及替代方法整理出来加以介绍。
 
+```commment
 ### 区块引用
 
 原本在Markdown中代表区块引用的\>号,在ZumDown中用于替代制表符缩进。而您如果想使用区块引用功能,请参照“Superblock”
+```
 
 ### 缩进和代码区块
 
-在ZumDown和部分其它的Markdown方言中,缩进通常都会被忽略。如果您想在文中利用缩进产生层级视觉效果,请使用原本在Markdown中代表区块引用的\>号,在ZumDown中它将代表一个制表符的缩进。
+在ZumDown和部分其它的Markdown方言中,缩进通常都会被忽略。如果您想在文中利用缩进产生层级视觉效果,请使用->号(必须从行首开始使用),在ZumDown中它将代表一个制表符的缩进。
 
 如果是在标准的Markdown中,四个空格或一个制表符代表的缩进是“代码块”,而该功能在ZumDown和部分其它的Markdown方言中被禁用。如果您想显示一些源代码,请参照文档的Superblock部分对code区块的介绍。