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

CSUwangj/md2docx-csharp

Repository files navigation

md2docx-csharpBuild status

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

该项目是CSUIS-md2docx的一个子项目,目前2.3版已经完工,下一步动向见TODO。

下载: latest release | latest CI build (master)(文档未完成)

快速开始

下载release中的Release.zip,解压后在解压的目录中,命令行使用。也可以将程序路径加入PATH方便使用。

无参数使用时除了提示信息外相当于md2docx.exe -i input.md -c config.json -o <id><name><filename>.docx

请注意图片路径的问题。

数学公式目前仅支持对一整个段落的处理,即以$$开头且结尾的段落被当作数学公式。处理过程借助了Pandoc,所以你需要安装Pandoc,并将其程序路径加入PATH。

编译

Visual Studio

使用Visual Studio(>=2017)打开.sln后进行编译,如果有缺少的库、VS支持,VS(理论上)会进行提示并可以进行相对自动化的安装。

MSBuild

MSBuild.exe md2docx.sln /p:Configuration=Debug /p:Platform="Any CPU"

MSBuild.exe md2docx.sln /p:Configuration=Release /p:Platform="Any CPU"

输出路径为md2docx\bin\(Debug|Release)

Markdown语法

specification

配置文件

schema文件为schema,示例文件为default config

文档

在我的博客中对写这个程序的过程做了一个简介,同时总结了一下用到的资料,暂且先用它吧。

TODO

未实现的TODO按照实现可能性降序排列

  • 加入测试(并重构)
  • 将格式等设置改为配置文件而非硬编码
  • 部署CI
  • 图片
  • 页眉
  • 页脚
  • 链接
  • 公式
  • 将parser更换成一个标准更接近GFM的parser
  • 根据文件设定路径
  • 表格
  • 列表
  • 图形化