一种基于Markdown标记语言的文档生成方法及系统技术方案

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

【技术实现步骤摘要】
一种基于Markdown标记语言的文档生成方法及系统


[0001]本专利技术涉及计算机
，尤其涉及一种基于Markdown标记语言的文档生成方法及系统。

技术介绍

[0002]Markdown是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。HTML则是一种用于创建网页的标准标记语言。软件产品的发布都带有帮助文档或指导文档，而专门的软件产品文档编写维护人员，较难掌握HTML文档的编写技能，而Markdown文档的编写却较为容易。另外，由于HTML文件可以有不同的展示样式，如果要针对不同版本的软件风格修改文档风格时，直接修改HTML文档的样式也较为复杂。
[0003]由于每次HTTP接口需要编写接口文档，有的项目使用showdoc，这种代码编写文件的方法效率低下，如果文件很大，接口文档存在版本化问题，如果接口变更了，需要更新接口文档；同时为了保障软件质量，需要单独编写接口测试代码，就会存在效率低下等问题，导致开发人员需要花费大量的时间。

技术实现思路

[0004]针对上述现有技术的现状，本专利技术所要解决的技术问题在于提出一种基于Markdown标记语言的文档生成方法及系统，用以解决上述存在的编写、修改复杂且效率低下的问题。
[0005]本专利技术一种基于Markdown标记语言的文档生成方法及系统，具体的包括以下技术方案：
[0006]一种基于Markdown标记语言的文档生成方法，包括步骤：
[0007]S1：定义Markdown标记符号与HTML标记符号的对应关系；
[0008]S2：创建HTML文档的CSS样式，定义生成HTML网页的展示样式；
[0009]S3：创建HTML文档的首页网页模板，将首页网页模板中定义预设区域为文档目录展示区域；
[0010]S4：读取Markdown书写的文档文件，按照步骤S3为HTML文档文件输出，并且按照Markdown书写的文档文件的目录全部结构，生成HTML文档的访问首页页面。
[0011]进一步地，所述步骤S1包括：
[0012]S11：按照Markdown标记符号与HTML标记符号的对应关系，建立符号转换对应表。
[0013]进一步地，所述步骤S4包括：
[0014]S41：按照入口目录的层次关系将Markdown文档目录结构中的子目录和Markdown文档生成HTML文档的目录结构；
[0015]S42：读取所述Markdown文档目录结构，按照目录结构的层次关系，生成文档的目录结构；
[0016]S43：获取所述首页网页模板，将步骤S42中生成的目录结构写入首页网页模板的
文档目录展示区域，将添加数据后的模板输出为首页HTML文件；
[0017]S44：按照步骤S42中生成的目录结构，创建HTML文档的目录，并将首页HTML文件写入顶层目录中。
[0018]进一步地，所述步骤S42包括：
[0019]S421：通过目录结构各层次的目录名称生成HTML文档目录的层次名称；
[0020]S422：将目录层次最末的HTML文档链接以文档名称进行命名。
[0021]进一步地，所述步骤S44之后还包括：
[0022]S45：按照所述Markdown文档目录结构，依次从目录中获取Markdown文档，依次对所有的Markdown文档进行解析；
[0023]S46：读取步骤S1中Markdown标记符号与HTML标记符号的对应关系，将Markdown文档中的标记转换为HTML标记，将整Markdown文档数据转化为HTML文档数据；
[0024]S47：将生成的各个HTML文档数据，存放入其所在的HTML文档目中；
[0025]S48：将所有Markdown文档转换为HTML文档，并将整个HTML文档目录压缩后，得到全部HTML文档。
[0026]一种基于Markdown标记语言的文档生成系统，包括：
[0027]定义模块：用于定义Markdown标记符号与HTML标记符号的对应关系；
[0028]第一创建模块：用于创建HTML文档的CSS样式，定义生成HTML网页的展示样式；
[0029]第二创建模块：用于创建HTML文档的首页网页模板，将首页网页模板中定义预设区域为文档目录展示区域；
[0030]读取生成模块：用于读取Markdown书写的文档文件，按照第二创建模块为HTML文档文件输出，并且按照Markdown书写的文档文件的目录全部结构，生成HTML文档的访问首页页面。
[0031]进一步地，所述定义模块包括：
[0032]建立单元：按照Markdown标记符号与HTML标记符号的对应关系，建立符号转换对应表。
[0033]进一步地，所述读取生成模块包括：
[0034]第一生成单元：按照入口目录的层次关系将Markdown文档目录结构中的子目录和Markdown文档生成HTML文档的目录结构；
[0035]第二生成单元：用于读取所述Markdown文档目录结构，按照目录结构的层次关系，生成文档的目录结构；
[0036]获取单元：用于获取所述首页网页模板，将第二生成单元中生成的目录结构写入首页网页模板的文档目录展示区域，将添加数据后的模板输出为首页HTML文件；
[0037]创建单元：按照第二生成单元中生成的目录结构，创建HTML文档的目录，并将首页HTML文件写入顶层目录中。
[0038]进一步地，所述第二生成单元包括：
[0039]第一子单元：通过目录结构各层次的目录名称生成HTML文档目录的层次名称；
[0040]第二子单元：用于将目录层次最末的HTML文档链接以文档名称进行命名。
[0041]进一步地，所述创建单元之后还包括：
[0042]解析单元：按照所述Markdown文档目录结构，依次从目录中获取Markdown文档，依
次对所有的Markdown文档进行解析；
[0043]读取单元：读取定义模块中Markdown标记符号与HTML标记符号的对应关系，将Markdown文档中的标记转换为HTML标记，将整Markdown文档数据转化为HTML文档数据；
[0044]存放单元：将生成的各个HTML文档数据，存放入其所在的HTML文档目中；
[0045]转换单元：将所有Markdown文档转换为HTML文档，并将整个HTML文档目录压缩后，得到全部HTML文档。
[0046]本专利技术采用上述技术方案包括以下有益效果：
[0047]本专利技术提出一种基于Markdown标记语言的文档生成方法及系统，该方法可以将Markdown编写的文档文件转换为HTML文档，并且支持自定义HTML展示样式，同时，还可以按照Markdown文档的目录结构，生成HTML文档的访问首页页面。
附图说明
[0048]图1为本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种基于Markdown标记语言的文档生成方法，其特征在于，包括步骤：S1：定义Markdown标记符号与HTML标记符号的对应关系；S2：创建HTML文档的CSS样式，定义生成HTML网页的展示样式；S3：创建HTML文档的首页网页模板，将首页网页模板中定义预设区域为文档目录展示区域；S4：读取Markdown书写的文档文件，按照步骤S3为HTML文档文件输出，并且按照Markdown书写的文档文件的目录全部结构，生成HTML文档的访问首页页面。2.根据权利要求1所述的基于Markdown标记语言的文档生成方法，其特征在于，所述步骤S1包括：S11：按照Markdown标记符号与HTML标记符号的对应关系，建立符号转换对应表。3.根据权利要求1所述的基于Markdown标记语言的文档生成方法，其特征在于，所述步骤S4包括：S41：按照入口目录的层次关系将Markdown文档目录结构中的子目录和Markdown文档生成HTML文档的目录结构；S42：读取所述Markdown文档目录结构，按照目录结构的层次关系，生成文档的目录结构；S43：获取所述首页网页模板，将步骤S42中生成的目录结构写入首页网页模板的文档目录展示区域，将添加数据后的模板输出为首页HTML文件；S44：按照步骤S42中生成的目录结构，创建HTML文档的目录，并将首页HTML文件写入顶层目录中。4.根据权利要求3所述的基于Markdown标记语言的文档生成方法，其特征在于，所述步骤S42包括：S421：通过目录结构各层次的目录名称生成HTML文档目录的层次名称；S422：将目录层次最末的HTML文档链接以文档名称进行命名。5.根据权利要求3所述的基于Markdown标记语言的文档生成方法，其特征在于，所述步骤S44之后还包括：S45：按照所述Markdown文档目录结构，依次从目录中获取Markdown文档，依次对所有的Markdown文档进行解析；S46：读取步骤S1中Markdown标记符号与HTML标记符号的对应关系，将Markdown文档中的标记转换为HTML标记，将整Markdown文档数据转化为HTML文档数据；S47：将生成的各个HTML文档数据，存放入其所在的HTML文档目中；S48：将所有Markdown文档转换为HTML文档，并将整个HTML文档目录压缩后，得到全部HTML文档。6.一种基于Markdown标记语言的文档生成系统，其特征在于...

【专利技术属性】
技术研发人员：俞建东，
申请(专利权)人：宁波柠清信息科技有限公司，
类型：发明
国别省市：