一种基于Markdown的文档管理方法
【专利摘要】本发明公开了一种基于Markdown的文档管理方法，属于项目文档的在线管理技术领域，基于Markdown+pandoc技术，采用脚本发布的方式，将用户编写的.md文档生成html文件并发布到文档开发项目对应的文件目录中；文档开发项目中使用sit一种基于Markdown的文档管理方法m一种基于Markdown的文档管理方法sh框架进行页面的布局，将网页的内容和页面结构分离，以达到顶部和左侧页面结构共享的目的。本发明从项目文档的管理出发，提供了一种文档在线化管理的方式，实现文档的规范化编写、生成、发布与展示，提高文档编写的效率。
【专利说明】
一种基于Ma r kd own的文档管理方法
技术领域
[0001 ]本发明涉及项目文档的在线管理技术领域，具体地说是一种基于Markdown的文档管理方法。
【背景技术】
[0002]传统意义上项目文档管理的本地化与用户需求的在线化相冲突，从而导致较低的工作效率及较多的工作量。
[0003]传统的文档管理方式是将项目相关的文档放在本地的doc文件夹中，用户使用时需要联系开发等相关管理人员，这样一来既浪费时间也增加相关人员的工作量。
【发明内容】
[0004]本发明的技术任务是针对以上不足之处，提供一种基于Markdown的文档管理方法，来解决项目文档管理的本地化与用户需求的在线化相冲突从而导致的较低的工作效率及较多的工作量的问题。
[0005]本发明解决其技术问题所采用的技术方案是:
一种基于Markdown的文档管理方法，包括:
基于Markdown+pandoc技术，采用脚本发布的方式，将用户编写的.md文档生成html文件并发布到文档开发项目对应的文件目录中；
文档开发项目中使用sit—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架进行页面的布局，将网页的内容和页面结构分离，以达到顶部和左侧页面结构共享的目的；
左侧页面结构采用垂直导航的形式来展现各业务模块文档的菜单及菜单项;左侧菜单叶子结点导航至具体文档的html页面，采用cooki—种基于Markdown的文档管理方法缓存的方式记录当前页面，使左侧对应的菜单项为选中状态。
[0006]sit一种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架技术是将页面结构与内容相分离的互联网风格的页面布署技术，在本项目中将页面结构分成顶部导航和左侧菜单、右侧内容两部分，利用sit—种基于Markdown的文档管理方法m一种基于Markdown的文档管理方法sh的配置文件将两个部分组合起来，形成一个页面。
[0007]左侧菜单部分利用cooki—种基于Markdown的文档管理方法缓存技术，将请求页面链接的共有属性data-nam—种基于Markdown的文档管理方法保存到页面的缓存中，以记录被请求的菜单项使其处于选中状态。
[0008]本发明的一种基于Markdown的文档管理方法和现有技术相比，具有以下有益效果:
提高文档编写的效率、提供给用户与开发者便于交流的接口、灵活的菜单项配置与保存技术、各业务间文档的独立发布易于业务的扩展；
提高文档编写的效率，利用Markdown与Pandoc技术，实现标记语言间的格式转换； 提供给用户与开发者便于交流的接口，使用户通过在线文档的预览快速定位所需要的内容，减少与开发者间不必要的联系，提高工作效率；
灵活的菜单项配置与保存技术，呈现给用户比较友好的用户交互界面；
各业务间文档的独立发布易于业务的扩展，减少各模间的发布冲突；
本专利从项目文档的管理出发，提供了一种文档在线化管理的方式，实现文档的规范化编写、生成、发布与展示。
【具体实施方式】
[0009]下面结合具体实施例对本发明作进一步说明。
[0010]一种基于Markdown的文档管理方法，包括:基于Markdown+pandoc技术，米用脚本发布的方式，将用户编写的.md文档生成html文件并发布到文档开发项目对应的文件目录中；
文档开发项目中使用sit—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架进行页面的布局，将网页的内容和页面结构分离，以达到顶部和左侧页面结构共享的目的；
左侧页面结构采用垂直导航的形式来展现各业务模块文档的菜单及菜单项;左侧菜单叶子结点导航至具体文档的html页面，采用cooki—种基于Markdown的文档管理方法缓存的方式记录当前页面，使左侧对应的菜单项为选中状态。
[0011]1、文档的编写与生成
说明:文档的编写与生成基于markdown和pandoc技术，并在各业务项目中编写文档发布的脚本文档d—种基于Markdown的文档管理方法ploy_to_wik1.xml。
[0012]Markdown是一种轻量级的标记语言，在使用该语言时，文档的编写者只需要关注文档的内容而不用担心平台与格式的困扰。在本实现方法中，各业务的文档编写者需在本地项目的doc文件夹中建立md子文件夹，里面放置使用markdown语法编写的.md文件及图片文件夹img。
[0013]为了文档的分享与多平台的使用，需要对MD文件进行格式转化，Pandoc是一个用于从一种标记格式转换为另一种的Hask—种基于Markdown的文档管理方法11库，它的功能是在多种常见的标记语言进行相互转换。由此，文档编写者在本地需要安装pandoc.—种基于Markdown的文档管理方法X—种基于Markdown的文档管理方法程序并编写d—种基于Markdown的文档管理方法ploy_to_wik1.xml脚本文件，将编写完成的.md文件转换成.html文件并发布至文档开发项目对应的文件夹中。
[0014]2、文档展示项目的架构布署
说明:文档开发项目中主要是存放与展示各业务项目发布过来的.html文档。文档的展不主要使用前端s it—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架技术进行布署配置，形成友好的界面交互。
[0015]sit一种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架技术是将页面结构与内容相分离的互联网风格的页面布署技术。在本项目中将页面结构分成顶部导航和左侧菜单、右侧内容两部分，利用sit—种基于Markdown的文档管理方法m一种基于Markdown的文档管理方法sh的配置文件将两个部分组合起来，形成一个页面。[ΟΟ??]左侧菜单部分利用cooki—种基于Markdown的文档管理方法缓存技术，将请求页面链接的共有属性data-nam—种基于Markdown的文档管理方法保存到页面的缓存中，以记录被请求的菜单项使其处于选中状态。各业务项目的文档编写者需要在左侧菜单页面中配置相应的菜单项。
[0017]通过上面【具体实施方式】，所述技术领域的技术人员可容易的实现本发明。但是应当理解，本发明并不限于上述的【具体实施方式】。在公开的实施方式的基础上，所述技术领域的技术人员可任意组合不同的技术特征，从而实现不同的技术方案。
[0018]除说明书所述的技术特征外，均为本专业技术人员的已知技术。
【主权项】
1.一种基于Markdown的文档管理方法，其特征在于包括: 基于Markdown+pandoc技术，采用脚本发布的方式，将用户编写的.md文档生成html文件并发布到文档开发项目对应的文件目录中； 文档开发项目中使用sit—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架进行页面的布局，将网页的内容和页面结构分离，以达到顶部和左侧页面结构共享； 左侧页面结构采用垂直导航的形式来展现各业务模块文档的菜单及菜单项；左侧菜单叶子结点导航至具体文档的html页面，采用cooki—种基于Markdown的文档管理方法缓存的方式记录当前页面，使左侧对应的菜单项为选中状态。2.根据权利要求1所述的一种基于Markdown的文档管理方法，其特征在于sit—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh框架技术是将页面结构与内容相分离的互联网风格的页面布署技术，在本项目中将页面结构分成顶部导航和左侧菜单、右侧内容两部分，利用sit—种基于Markdown的文档管理方法m—种基于Markdown的文档管理方法sh的配置文件将两个部分组合起来，形成一个页面。3.根据权利要求1所述的一种基于Markdown的文档管理方法，其特征在于左侧菜单部分利用cooki —种基于Markdown的文档管理方法缓存技术，将请求页面链接的共有属性data-nam—种基于Markdown的文档管理方法保存到页面的缓存中，以记录被请求的菜单项使其处于选中状态。
【文档编号】G06F17/30GK106095889SQ201610397398
【公开日】2016年11月9日
【申请日】2016年6月7日 公开号201610397398.6, CN 106095889 A, CN 106095889A, CN 201610397398, CN-A-106095889, CN106095889 A, CN106095889A, CN201610397398, CN201610397398.6
【发明人】彭文净, 吴玉雁
【申请人】浪潮软件股份有限公司