[发明专利]一种基于Markdown标记语言的文档生成方法及系统

说明书

本发明涉及计算机技术领域，公开了一种基于Markdown标记语言的文档生成方法及系统，本方法包括步骤：S1：定义Markdown标记符号与HTML标记符号的对应关系；S2：创建HTML文档的CSS样式，定义生成HTML网页的展示样式；S3：创建HTML文档的首页网页模板，将首页网页模板中定义预设区域为文档目录展示区域；S4：读取Markdown书写的文档文件，按照步骤S3为HTML文档文件输出。本方法可以将Markdown编写的文档文件转换为HTML文档，并且支持自定义HTML展示样式，还可以按照Markdown文档的目录结构，生成HTML文档的访问首页页面。

技术领域

本发明涉及计算机技术领域，尤其涉及一种基于Markdown标记语言的文档生成方法及系统。

背景技术

Markdown是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。HTML则是一种用于创建网页的标准标记语言。软件产品的发布都带有帮助文档或指导文档，而专门的软件产品文档编写维护人员，较难掌握HTML文档的编写技能，而Markdown文档的编写却较为容易。另外，由于HTML文件可以有不同的展示样式，如果要针对不同版本的软件风格修改文档风格时，直接修改HTML文档的样式也较为复杂。

由于每次HTTP接口需要编写接口文档，有的项目使用showdoc，这种代码编写文件的方法效率低下，如果文件很大，接口文档存在版本化问题，如果接口变更了，需要更新接口文档；同时为了保障软件质量，需要单独编写接口测试代码，就会存在效率低下等问题，导致开发人员需要花费大量的时间。

发明内容

针对上述现有技术的现状，本发明所要解决的技术问题在于提出一种基于Markdown标记语言的文档生成方法及系统，用以解决上述存在的编写、修改复杂且效率低下的问题。

本发明一种基于Markdown标记语言的文档生成方法及系统，具体的包括以下技术方案：

一种基于Markdown标记语言的文档生成方法，包括步骤：

S1：定义Markdown标记符号与HTML标记符号的对应关系；

S2：创建HTML文档的CSS样式，定义生成HTML网页的展示样式；

S3：创建HTML文档的首页网页模板，将首页网页模板中定义预设区域为文档目录展示区域；

S4：读取Markdown书写的文档文件，按照步骤S3为HTML文档文件输出，并且按照Markdown书写的文档文件的目录全部结构，生成HTML文档的访问首页页面。

进一步地，所述步骤S1包括：

S11：按照Markdown标记符号与HTML标记符号的对应关系，建立符号转换对应表。

进一步地，所述步骤S4包括：

S41：按照入口目录的层次关系将Markdown文档目录结构中的子目录和Markdown文档生成HTML文档的目录结构；

S42：读取所述Markdown文档目录结构，按照目录结构的层次关系，生成文档的目录结构；

S43：获取所述首页网页模板，将步骤S42中生成的目录结构写入首页网页模板的文档目录展示区域，将添加数据后的模板输出为首页HTML文件；

S44：按照步骤S42中生成的目录结构，创建HTML文档的目录，并将首页HTML文件写入顶层目录中。

进一步地，所述步骤S42包括：

S421：通过目录结构各层次的目录名称生成HTML文档目录的层次名称；

S422：将目录层次最末的HTML文档链接以文档名称进行命名。