Skip to content
This repository was archived by the owner on May 21, 2022. It is now read-only.

Commit 351a899

Browse files
committed
docs: update readme
1 parent 7369133 commit 351a899

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1-
# md2docx-csharp[![Build status](https://ci.appveyor.com/api/projects/status/github/CSUwangj/md2docx-csharp?branch=master&svg=true)](https://ci.appveyor.com/project/CSUwangj/md2docx-csharp/branch/master)
1+
# md2docx-csharp![](https://img.shields.io/github/license/CSUwangj/md2docx-csharp)[![Build status](https://ci.appveyor.com/api/projects/status/github/CSUwangj/md2docx-csharp?branch=master&svg=true)](https://ci.appveyor.com/project/CSUwangj/md2docx-csharp/branch/master)![](https://img.shields.io/github/v/release/CSUwangj/md2docx-csharp?include_prereleases)
22

3-
---
43
使用C#开发的将markdown转换为docx的工具。
54

6-
该项目是[CSUIS-md2docx](https://github.com/CSUwangj/CSUIS-md2docx)的一个子项目,目前1.0版已经完工,下一步动向见TODO。
5+
该项目是[CSUIS-md2docx](https://github.com/CSUwangj/CSUIS-md2docx)的一个子项目,目前2.1版已经完工,下一步动向见TODO。
76

87
下载: [latest release](https://github.com/CSUwangj/md2docx-csharp/releases) | [latest CI build (master)](https://ci.appveyor.com/api/projects/CSUwangj/md2docx-csharp/artifacts/md2docx/bin/md2docx.zip)(文档未完成)
98

109
## 快速开始
1110

12-
下载release中的`Release.zip`,解压后在解压的目录中,命令行使用,若无参数,则默认输入文件为同文件夹下的`test.md`
11+
下载release中的`Release.zip`,解压后在解压的目录中,命令行使用。也可以将程序路径加入PATH方便使用
1312

14-
运行参数为`md2docx.exe <md input path> <docx output path>`,若不指定第一个参数,则默认读入同目录的`test.md`,若不指定第二个参数,则按照`<name><ID><filename>.docx`存储文件,各参数来自于markdown文件的yaml头部。
13+
无参数使用时除了提示信息外相当于`md2docx.exe -i input.md -c config.json -o <id><name><filename>.docx`
14+
15+
请注意图片路径的问题。
1516

1617
## 编译
1718

@@ -41,11 +42,15 @@ schema文件为[schema](./docs/schema.json),示例文件为[default config](./
4142

4243
## TODO
4344

45+
未实现的TODO按照实现可能性降序排列
46+
4447
- [x] 加入测试(并重构)
4548
- [x] 将格式等设置改为配置文件而非硬编码
4649
- [x] 部署CI
47-
- [ ] 将parser更换成一个标准更接近GFM的parser
50+
- [x] 图片
51+
- [ ] 根据文件设定路径
4852
- [ ] 页眉
4953
- [ ] 页脚
50-
- [ ] 图片
54+
- [ ] 将parser更换成一个标准更接近GFM的parser
5155
- [ ] 表格
56+
- [ ] 图形化

0 commit comments

Comments
 (0)