CN108376127A - 一种文档生成的方法、装置及计算机可读存储介质 - Google Patents

Abstract

本发明提供一种文档生成的方法，包括如下步骤：输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；将所述初始文档生成能够在局域网在线浏览的文件；将所述在线浏览的文件上传到服务器上，生成在线文档。本发明还提供一种相关装置和一种相关计算机可读存储介质。

Description

一种文档生成的方法、装置及计算机可读存储介质

技术领域

本发明涉及计算机应用技术领域，尤其涉及一种文档生成的方法、装置及计算机可读存储介质。

背景技术

文档是技术人员进行技术交流的常用手段，例如在产品研发过程需要多个技术人员协同工作，不同的技术人员负责不同的部分，技术人员通过更新文档来向其他技术人员通告研发进展情况。此外，企业内部也利用文档作为信息载体向企业员工发布信息。

文档包括技术内容和一定的格式，为了使得技术人员专注于技术内容而不必考虑格式问题，现有技术中提供了很多工具。例如，轻量级语言markdown。

CN106294493披露了进行文档格式转换的装置和方法，但是其只能对本地文档进行转换，无法生成在线文档。另外一方面，现有技术中提供的生成在线文档的工具有看云、gitbook等，而这些工具在对文档内容进行编辑的过程，需要利用因特网环境在线完成，从而无法保证文档信息的安全性。

发明内容

为了克服上述问题的至少一个方面，本发明实施例提供一种文档生成的方法、装置及计算机可读存储介质。

根据本发明的一个方面，提供一种文档生成的方法，包括如下步骤：

输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；

读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；

将所述初始文档生成能够在局域网在线浏览的文件；

将所述在线浏览的文件上传到服务器上，生成在线文档。

根据一些实施例，所述文档格式信息包括：页面标题、页面标签图标、文档logo图片、页面主题色、页脚信息和目录结构。

根据一些实施例，在所述文件夹内的所有markdown文件全部读取完成后，检查是否存在异常文件，如果存在，发出异常信息通知用户并终止过程。

根据一些实施例，所述方法还包括对所述在线浏览的文件进行修改，修改过程即时反应到浏览器。

根据一些实施例，通过修改markdown语法样式文件内容来修改所述在线浏览的文件。

根据本发明的另一个方面，提供一种文档生成的装置，其至少包括：

输入模块，用于输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；

转换模块，用于读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；

生成模块，用于将所述初始文档生成能够在局域网在线浏览的文件；

上传模块，用于将所述在线浏览的文件上传到服务器上，生成在线文档。

根据一些实施例，所述装置还包括：检查模块，用于在所述文件夹内的所有markdown文件全部读取完成后，检查是否存在异常文件，并在存在异常文件时发出异常信息通知用户并终止过程。

根据一些实施例，所述装置还包括：修改模块，用于修改所述在线浏览的文件，并将修改过程即时反应到浏览器。

根据本发明的又一个方面，提供一种文档生成的计算机可读存储介质，其上存储有可执行指令，指令在由处理器执行时，可以实现根据上述实施例中的任一项所述的文档生成的方法的步骤。

与现有技术相比，本发明具有以下优点：不需要网络环境，保证文档的安全性，同时对用户十分友好，操作简便，输出的文档能快速访问。

附图说明

通过下文中参照附图对本发明所作的描述，本发明的其它目的和优点将显而易见，并可帮助对本发明有全面的理解。

图1是本发明实施例的工作流程图；

图2是本发明实施例的装置的整体示意图；

图3是本发明实施例的计算机可读存储介质的结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

在本发明实施例中使用的术语是仅仅出于描述特定实施例的目的，而非旨在限制本发明。除非另外定义，本发明使用的技术术语或者科学术语应当为本发明所属领域内具有一般技能的人士所理解的通常意义。

在本发明实施例的一个方面，通过设置具体的文档格式，将markdown文件快速在本地生成符合所想要的格式的文档，且生成的文档可以快速访问，十分方便快捷，整个过程都运行在本地，无需经过网络，也就不用担心文档信息的泄露，保证了文档信息的安全。

下面结合附图，对本发明的实施方案进行详细描述。

参见图1，为本发明实施例提供的一种文档生成的方法的流程图。如图1所示，该实施例可以包括：

S101、输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内。

需要说明的是，markdown文件并不依赖于使用特定的编辑器，任何符合markdown语法的文本内容保存为后缀名md的文件后即为合法的、可被识别和处理的markdown文件。

在这个步骤里，可以调用Node.js内置的文件系统API读取structure.json文件，此文件具有特定格式，由用户填写对应的文档格式信息。文档格式信息可以指所有对于文档的表现形式有影响的信息，例如，在一些可能的实施例中，文档格式信息可以包括：页面标题、页面标签图标、文档logo图片、页面主题色、页脚信息和目录结构。当然并不局限于此。其中，页面标题、页面标签图标、文档logo图片和页脚信息可以以Dom形式插入主页模板，生成index.html主页文件；主题色信息可以交由样式文件模板，生成index.css样式文件。

用户输入的markdown文件可能不止一件，可以将这些markdown文件统一存储到一个文件夹中便于对这些文件的读取。

S102、读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档。

在S101步骤中用户输入的文档格式信息中可以包括页面结构信息，这些信息可以以数组的形式缓存，从而形成页面结构信息数组。页面结构数组中可以包括目录章节。可以在读取完每一个markdown文件后将该文件的文件名与页面结构数组中的目录章节匹配，一旦匹配成功，则说明该文件是有效文件，就可以进行后续操作，然后就可以将该文件转换为html片段，也即是超文本标记语言片段。将markdown文件转换成html片段可以借助于第三方转换器。

将markdown文件转换成html片段的一个好处是可以插入到模板中，便于形成最终的格式。在将markdown文件转换成html片段后，可以同时执行以下两项操作：(1)将该html片段插入到文档模板的尾部；(2)生成一个该html片段的链接尾部插入到目录模板。

在一些可能的实施例中，在markdown文件夹中的所有markdown文件全部读取完成后，可以检查是否存在异常文件，例如，可以检查页面结构数组中是否有未匹配过的目录章节。如果存在异常文件，可以发出异常信息通知用户并终止过程。

如果未发现异常文件，可以调用webpack将三个来源的所有文件打包：(1)步骤S101中得到的index.html主页文件和index.css样式文件；(2)本步骤中得到的文档模版和目录模版；(3)工具内置的markdown语法样式文件markdown.css。在打包过程正常完成后，启动express为打包所得文件提供http服务，此时用户即可通过打印信息提供的地址和端口号访问到本机上的在线文档，也即是可以将打包文件转换成符合文档格式信息所记载的文档格式的初始文档。

S103、将所述初始文档生成能够在局域网在线浏览的文件。

可以为初始文档提供网络服务，用户可以通过网址和\或端口号访问到局域网内的在线文档。在一些可能的实施例中，用户可能想要自定义markdown语法样式，从而实现独具一格的目的，这时就可以自主修改markdown语法样式文件，例如，可以修改markdown.css文件内容，整个修改的过程也可以通过热重载的方式即时反应到浏览器上。

另外，采用SPA和PWA技术能够降低页面之间的切换时间，提升页面切换的体验。SPA是single-page App的缩写，是指单页面应用，其能极大提升加载速度并减少初始加载体积；PWA是progressive Web App的缩写，是指渐进式应用，是一种全新的网页技术，它能让网页的离线体验变得更好，它会模拟一些原生功能，比如通知推送。在移动端利用标准化框架，让网页应用呈现和原生应用相似的体验。两者配合使用能大大降低网页渲染的时间，极大提升用户体验。在一些可能的实施例中，SPA和PWA可以和打包工具结合使用。

S104、将所述在线浏览的文件上传到服务器上，生成在线文档。

用户将在线浏览的文件修改成自己想要的样式后，可以将其上传到服务器上，这样便形成了在线文档。当然，用户也可以不对在线浏览的文件进行修改，直接上传到服务器上。

与上述生成文档的方法相应地，本发明还提供了另一种生成文档的装置。例如，参见图2所示的生成文档装置示意图。如图2所示，该装置200可以包括：输入模块201，可以用于输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；转换模块202，可以用于读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；生成模块203，可以用于将所述初始文档生成能够在局域网在线浏览的文件；上传模块204，可以用于将所述在线浏览的文件上传到服务器上，生成在线文档。

在一些可能的实施方式中，装置还可以包括检查模块，可以用于在所述文件夹内的所有markdown文件全部读取完成后，检查是否存在异常文件，并在存在异常文件时发出异常信息通知用户并终止过程。

在一些可能的实施方式中，装置还可以包括修改模块，用于修改所述在线浏览的文件，并将修改过程即时反应到浏览器。

为了描述的方便，描述以上装置时以功能分为各种模块分别描述。当然，在实施本发明时可以把各单元的功能在同一个或多个软件和/或硬件中实现。

基于同一发明构思，参考图3所示，本发明还提供一种计算机可读存储介质301，其上存储有可执行指令302，可执行指令302执行时，可以实现根据上述实施例中的任一项所述的生成文档的方法的步骤。

最后应说明的是：以上实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的精神和范围。

Claims (9)

1.一种文档生成的方法，其特征在于，包括：

输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；

读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；

将所述初始文档生成能够在局域网在线浏览的文件；

将所述在线浏览的文件上传到服务器上，生成在线文档。

2.根据权利要求1所述的方法，其特征在于，所述文档格式信息包括：页面标题、页面标签图标、文档logo图片、页面主题色、页脚信息和目录结构。

3.根据权利要求1所述的方法，其特征在于，还包括：

在所述文件夹内的所有markdown文件全部读取完成后，检查是否存在异常文件，如果存在，发出异常信息通知用户并终止过程。

4.根据权利要求1所述的方法，其特征在于，还包括：

对所述在线浏览的文件进行修改，修改过程即时反应到浏览器。

5.根据权利要求4所述的方法，其特征在于，通过修改markdown语法样式文件内容来修改所述在线浏览的文件。

6.一种文档生成的装置，其特征在于，包括：

输入模块，用于输入文档格式信息和markdown文件，并将markdown文件存储在文件夹内；

转换模块，用于读取所述文件夹内的所有markdown文件，将所有markdown文件转换为符合所述文档格式信息所记载的文档格式的初始文档；

生成模块，用于将所述初始文档生成能够在局域网在线浏览的文件；

上传模块，用于将所述在线浏览的文件上传到服务器上，生成在线文档。

7.根据权利要求6所述的装置，其特征在于，还包括：

检查模块，用于在所述文件夹内的所有markdown文件全部读取完成后，检查是否存在异常文件，并在存在异常文件时发出异常信息通知用户并终止过程。

8.根据权利要求6所述的装置，其特征在于，还包括：

修改模块，用于修改所述在线浏览的文件，并将修改过程即时反应到浏览器。

9.一种文档生成的计算机可读存储介质，其上存储有可执行指令，所述指令在由处理器执行时，实现根据权利要求1-5中的任一项所述的文档生成的方法的步骤。