docs: add docs

Author: CSUwangj

README.md

@@ -1,26 +1,28 @@
 # md2docx-csharp
 
-使用C#开发的md2docx工具。
+使用C#开发的将markdown转换为docx的工具。
 
-## TBD
+该项目是[CSUIS-md2docx](https://github.com/CSUwangj/CSUIS-md2docx)的一个子项目，目前1.0版已经完工，下一步动向见TODO。
 
-这个项目是[CSUIS-md2docx](https://github.com/CSUwangj/CSUIS-md2docx)的一个子项目，目前还在开发中，在功能达到完善之前不会进一步更新文档。
+## 快速开始
 
-目前进度如下：
+下载release中的`Release.zip`，解压后在解压的目录中，命令行使用，若无参数，则默认输入文件为同文件夹下的`test.md`。
 
-- [x] 根据YAML头输出一个有姓名等内容的基本文档
-- [x] 标题、正文
-- [x] 摘要、关键词、结束语
-- [x] 页边距
-- [x] 参考文献
-- [x] 封面
-- [x] 目录
+运行参数为`md2docx.exe <md input path> <docx output path>`，若不指定第一个参数，则默认读入同目录的`test.md`，若不指定第二个参数，则按照`<name><ID><filename>.docx`存储文件，各参数来自于markdown文件的yaml头部。
 
-以上为我心中该项目demo的应有功能，在此之前除了更新进度外不会做进一步的文档更新。
+## 编译
 
-同时以下功能虽然也可以开发，但是考虑其复杂性无法保证进度，并且手动调整相对方便。在我有空之后会继续开发以下功能。
+使用Visual Studio(>=2017)打开.sln后进行编译，如果有缺少的库、VS支持，VS（理论上）会进行提示并可以进行相对自动化的安装。
+
+## Markdown语法
+
+见[specification](./docs/spec.md)
+
+## TODO
 
 - [ ] 页眉
 - [ ] 页脚
+- [ ] 将格式等设置改为配置文件而非硬编码
+- [ ] 将parser更换成一个标准更接近GFM的parser
 - [ ] 图片
-- [ ] 表格
+- [ ] 表格

docs/res/docx.jpg

@@ -0,0 +1,189 @@
+# Markdown定义
+
+考虑需求，这里分为两部分，分别是按照markdown视角看parser用的语法，和按照报告的格式内容来看markdown的对应内容。
+
+## markdown视角
+
+### YAML头部
+
+```markdown
+---
+key: value
+---
+```
+
+需要注意的是，这个parser的YAML头部不允许值中有换行，也不允许有值是列表。（好菜的parser）
+
+### 标题
+
+语法为`#{1,3}title`，与GFM等标注相比需要注意的是中间没有空格。
+
+标题中可以有粗体等特殊效果，支持的效果列表和正文一样。但是建议不要使用。
+
+目前在把配置改成配置文件之前不考虑支持4级及以上的标题。
+
+## 正文
+
+和普通markdown一样，允许有嵌套、交错的加粗、斜体、删除线等。支持以下语法：
+
+`**加粗**`**加粗**
+
+`*斜体*`或者`_斜体_`*斜体*
+
+`***加粗倾斜***`***加粗倾斜***
+
+`~~删除线~~`删除线
+
+`^上标^`^上标^
+
+`下标`<sub>下标</sub>
+
+```
+`代码节`
+```
+
+`代码节`
+
+### 引用
+
+```
+> 这里放引用
+```
+
+> 这里放引用
+
+引用块将被渲染为参考文献，因为参考文献位于文件末尾而且前面有一个结束语，所以目前请保证文件中只有一个引用块并且被放置于末尾。同时，不支持嵌套。
+
+### 暂时不支持的语法
+
+#### 代码块
+
+````c
+```c
+//这里面放代码
+int main(int argc, char **argv){
+  printf("Hello, World");
+  return 0;
+}
+```
+````
+
+后续将会把这部分按照正文的代码片段进行渲染。
+
+#### 水平分割线
+
+用regex表示语法为`----*`
+
+---
+
+后续将会把水平分割线渲染为分页符。
+
+#### 列表
+
+无序列表
+
+```
+* Item 1
++ Item 2
+- Item 3
+```
+
+* Item 1
++ Item 2
+- Item 3
+
+有序列表
+
+```
+7. Item 1
+2. Item 2
+5. Item 3
+```
+
+7. Item 1
+2. Item 2
+5. Item 3
+
+#### 表格
+
+```
+some|header|labels
+:---|:--:|---:
+Left-justified|center-justified|right-justified
+a|b|c
+d|e|f
+```
+
+some|header|labels
+:---|:--:|---:
+Left-justified|center-justified|right-justified
+a|b|c
+d|e|f
+
+#### 图片
+
+```
+![Helpers Image](https://raw.githubusercontent.com/windows-toolkit/WindowsCommunityToolkit/master/Microsoft.Toolkit.Uwp.SampleApp/Assets/Helpers.png)
+```
+
+![Helpers Image](https://raw.githubusercontent.com/windows-toolkit/WindowsCommunityToolkit/master/Microsoft.Toolkit.Uwp.SampleApp/Assets/Helpers.png)
+
+#### 链接
+
+```
+[Wikipedia](http://en.wikipedia.org)
+
+[Email](email@email.com)
+```
+
+[Wikipedia](http://en.wikipedia.org)
+
+[Email](email@email.com)
+
+#### EMOJI
+
+`:smile:`
+
+:smile:
+
+## 报告视角
+
+### 封面
+
+封面的各信息均来自于yaml头部，对应关系参考下图
+
+![yaml](./res/yaml.jpg)
+
+![docx](res/docx.jpg)
+
+时间会自动采用生成时候的时间。
+
+### 摘要
+
+摘要是一个可选项，在yaml头部中定义c_abs、c_title、c_kew会自动生成中文的摘要，定义e_abs、e_title、e_kew。如果只需要其中的部分，也需要定义所有的键，否则会生成错误。
+
+此外yaml头部不允许换行，也不允许列表。
+
+### 目录
+
+不需要自己写，将会自动在摘要（如果摘要不存在则是封面）之后生成。生成的默认内容是提示更新目录，只需点一下更新目录即可。
+
+### 正文
+
+使用正常markdown语法即可，需要注意的是`#`与标题内容之间不要有空格。
+
+### 结束语
+
+放在yaml头部的end键中，同样的，不要有换行。
+
+### 参考文献
+
+在文章末尾使用引用格式放出，例子如下
+
+```
+> [1]  王阳. 第三人称叙事的形式叙述者的限定[J]. 四川外语学院学报,2000(1):1-6.
+>
+> [2]  HAIMAN J. The Iconicity of Grammar[J]. Language,1980(56):515-540.
+>
+> [3]  陈牧. 拓扑绝缘体薄膜表面态和掺杂效应的STM研究[D]. 清华大学,2012.
+```

docs/res/yaml.jpg

@@ -203,6 +203,8 @@ private static void GenerateMainDocumentPart1Content(MainDocumentPart mainDocume
 
             Body docBody = new Body();
 
+            bool genEnd = false;
+
             ImagePart imagePart1 = mainDocumentPart1.AddNewPart<ImagePart>("image/jpeg", "rId8");
             GenerateImagePart1Content(imagePart1);
             GenerateCover(ref docBody);
@@ -255,9 +257,10 @@ private static void GenerateMainDocumentPart1Content(MainDocumentPart mainDocume
                 }
                 else if (element is QuoteBlock refer)
                 {
-                    if (endnote != "")
+                    if (endnote != "" && !genEnd)
                     {
                         Add_endnote(endnote, "结束语", ref docBody);
+                        genEnd = true;
                     }
 
                     Paragraph para = new Paragraph
@@ -283,6 +286,12 @@ private static void GenerateMainDocumentPart1Content(MainDocumentPart mainDocume
                 }
             }
 
+            if (endnote != "" && !genEnd)
+            {
+                Add_endnote(endnote, "结束语", ref docBody);
+                genEnd = true;
+            }
+
             SectionProperties sectionProperties1 = new SectionProperties() { RsidR = "00803857" };
             PageSize pageSize1 = new PageSize() { Width = (UInt32Value)11906U, Height = (UInt32Value)16838U };
             PageMargin pageMargin1 = new PageMargin() { Top = 1418, Right = (UInt32Value)1134U, Bottom = 1418, Left = (UInt32Value)1701U, Header = (UInt32Value)851U, Footer = (UInt32Value)992U, Gutter = (UInt32Value)0U };