一種基于Markdown的文檔管理方法
【專(zhuān)利摘要】本發(fā)明公開(kāi)了一種基于Markdown的文檔管理方法，屬于項(xiàng)目文檔的在線管理技術(shù)領(lǐng)域，基于Markdown+pandoc技術(shù)，采用腳本發(fā)布的方式，將用戶(hù)編寫(xiě)的.md文檔生成html文件并發(fā)布到文檔開(kāi)發(fā)項(xiàng)目對(duì)應(yīng)的文件目錄中；文檔開(kāi)發(fā)項(xiàng)目中使用sit一種基于Markdown的文檔管理方法m一種基于Markdown的文檔管理方法sh框架進(jìn)行頁(yè)面的布局，將網(wǎng)頁(yè)的內(nèi)容和頁(yè)面結(jié)構(gòu)分離，以達(dá)到頂部和左側(cè)頁(yè)面結(jié)構(gòu)共享的目的。本發(fā)明從項(xiàng)目文檔的管理出發(fā)，提供了一種文檔在線化管理的方式，實(shí)現(xiàn)文檔的規(guī)范化編寫(xiě)、生成、發(fā)布與展示，提高文檔編寫(xiě)的效率。
【專(zhuān)利說(shuō)明】
一種基于Ma r kd own的文檔管理方法
技術(shù)領(lǐng)域
[0001 ]本發(fā)明涉及項(xiàng)目文檔的在線管理技術(shù)領(lǐng)域，具體地說(shuō)是一種基于Markdown的文檔管理方法。
【背景技術(shù)】
[0002]傳統(tǒng)意義上項(xiàng)目文檔管理的本地化與用戶(hù)需求的在線化相沖突，從而導(dǎo)致較低的工作效率及較多的工作量。
[0003]傳統(tǒng)的文檔管理方式是將項(xiàng)目相關(guān)的文檔放在本地的doc文件夾中，用戶(hù)使用時(shí)需要聯(lián)系開(kāi)發(fā)等相關(guān)管理人員，這樣一來(lái)既浪費(fèi)時(shí)間也增加相關(guān)人員的工作量。

【發(fā)明內(nèi)容】

[0004]本發(fā)明的技術(shù)任務(wù)是針對(duì)以上不足之處，提供一種基于Markdown的文檔管理方法，來(lái)解決項(xiàng)目文檔管理的本地化與用戶(hù)需求的在線化相沖突從而導(dǎo)致的較低的工作效率及較多的工作量的問(wèn)題。
[0005]本發(fā)明解決其技術(shù)問(wèn)題所采用的技術(shù)方案是:
一種基于Markdown的文檔管理方法，包括:
基于Markdown+pandoc技術(shù)，采用腳本發(fā)布的方式，將用戶(hù)編寫(xiě)的.md文檔生成html文件并發(fā)布到文檔開(kāi)發(fā)項(xiàng)目對(duì)應(yīng)的文件目錄中；
文檔開(kāi)發(fā)項(xiàng)目中使用sit—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架進(jìn)行頁(yè)面的布局，將網(wǎng)頁(yè)的內(nèi)容和頁(yè)面結(jié)構(gòu)分離，以達(dá)到頂部和左側(cè)頁(yè)面結(jié)構(gòu)共享的目的；
左側(cè)頁(yè)面結(jié)構(gòu)采用垂直導(dǎo)航的形式來(lái)展現(xiàn)各業(yè)務(wù)模塊文檔的菜單及菜單項(xiàng);左側(cè)菜單葉子結(jié)點(diǎn)導(dǎo)航至具體文檔的html頁(yè)面，采用cooki—種基于Markdown的文檔管理方法緩存的方式記錄當(dāng)前頁(yè)面，使左側(cè)對(duì)應(yīng)的菜單項(xiàng)為選中狀態(tài)。
[0006]sit一種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架技術(shù)是將頁(yè)面結(jié)構(gòu)與內(nèi)容相分離的互聯(lián)網(wǎng)風(fēng)格的頁(yè)面布署技術(shù)，在本項(xiàng)目中將頁(yè)面結(jié)構(gòu)分成頂部導(dǎo)航和左側(cè)菜單、右側(cè)內(nèi)容兩部分，利用sit—種基于Markdown的文檔管理方法m一種基于Markdown的文檔管理方法sh的配置文件將兩個(gè)部分組合起來(lái)，形成一個(gè)頁(yè)面。
[0007]左側(cè)菜單部分利用cooki—種基于Markdown的文檔管理方法緩存技術(shù)，將請(qǐng)求頁(yè)面鏈接的共有屬性data-nam—種基于Markdown的文檔管理方法保存到頁(yè)面的緩存中，以記錄被請(qǐng)求的菜單項(xiàng)使其處于選中狀態(tài)。
[0008]本發(fā)明的一種基于Markdown的文檔管理方法和現(xiàn)有技術(shù)相比，具有以下有益效果:
提高文檔編寫(xiě)的效率、提供給用戶(hù)與開(kāi)發(fā)者便于交流的接口、靈活的菜單項(xiàng)配置與保存技術(shù)、各業(yè)務(wù)間文檔的獨(dú)立發(fā)布易于業(yè)務(wù)的擴(kuò)展；
提高文檔編寫(xiě)的效率，利用Markdown與Pandoc技術(shù)，實(shí)現(xiàn)標(biāo)記語(yǔ)言間的格式轉(zhuǎn)換； 提供給用戶(hù)與開(kāi)發(fā)者便于交流的接口，使用戶(hù)通過(guò)在線文檔的預(yù)覽快速定位所需要的內(nèi)容，減少與開(kāi)發(fā)者間不必要的聯(lián)系，提高工作效率；
靈活的菜單項(xiàng)配置與保存技術(shù)，呈現(xiàn)給用戶(hù)比較友好的用戶(hù)交互界面；
各業(yè)務(wù)間文檔的獨(dú)立發(fā)布易于業(yè)務(wù)的擴(kuò)展，減少各模間的發(fā)布沖突；
本專(zhuān)利從項(xiàng)目文檔的管理出發(fā)，提供了一種文檔在線化管理的方式，實(shí)現(xiàn)文檔的規(guī)范化編寫(xiě)、生成、發(fā)布與展示。
【具體實(shí)施方式】
[0009]下面結(jié)合具體實(shí)施例對(duì)本發(fā)明作進(jìn)一步說(shuō)明。
[0010]一種基于Markdown的文檔管理方法，包括:基于Markdown+pandoc技術(shù)，米用腳本發(fā)布的方式，將用戶(hù)編寫(xiě)的.md文檔生成html文件并發(fā)布到文檔開(kāi)發(fā)項(xiàng)目對(duì)應(yīng)的文件目錄中；
文檔開(kāi)發(fā)項(xiàng)目中使用sit—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架進(jìn)行頁(yè)面的布局，將網(wǎng)頁(yè)的內(nèi)容和頁(yè)面結(jié)構(gòu)分離，以達(dá)到頂部和左側(cè)頁(yè)面結(jié)構(gòu)共享的目的；
左側(cè)頁(yè)面結(jié)構(gòu)采用垂直導(dǎo)航的形式來(lái)展現(xiàn)各業(yè)務(wù)模塊文檔的菜單及菜單項(xiàng);左側(cè)菜單葉子結(jié)點(diǎn)導(dǎo)航至具體文檔的html頁(yè)面，采用cooki—種基于Markdown的文檔管理方法緩存的方式記錄當(dāng)前頁(yè)面，使左側(cè)對(duì)應(yīng)的菜單項(xiàng)為選中狀態(tài)。
[0011]1、文檔的編寫(xiě)與生成
說(shuō)明:文檔的編寫(xiě)與生成基于markdown和pandoc技術(shù)，并在各業(yè)務(wù)項(xiàng)目中編寫(xiě)文檔發(fā)布的腳本文檔d—種基于Markdown的文檔管理方法ploy_to_wik1.xml。
[0012]Markdown是一種輕量級(jí)的標(biāo)記語(yǔ)言，在使用該語(yǔ)言時(shí)，文檔的編寫(xiě)者只需要關(guān)注文檔的內(nèi)容而不用擔(dān)心平臺(tái)與格式的困擾。在本實(shí)現(xiàn)方法中，各業(yè)務(wù)的文檔編寫(xiě)者需在本地項(xiàng)目的doc文件夾中建立md子文件夾，里面放置使用markdown語(yǔ)法編寫(xiě)的.md文件及圖片文件夾img。
[0013]為了文檔的分享與多平臺(tái)的使用，需要對(duì)MD文件進(jìn)行格式轉(zhuǎn)化，Pandoc是一個(gè)用于從一種標(biāo)記格式轉(zhuǎn)換為另一種的Hask—種基于Markdown的文檔管理方法11庫(kù)，它的功能是在多種常見(jiàn)的標(biāo)記語(yǔ)言進(jìn)行相互轉(zhuǎn)換。由此，文檔編寫(xiě)者在本地需要安裝pandoc.—種基于Markdown的文檔管理方法X—種基于Markdown的文檔管理方法程序并編寫(xiě)d—種基于Markdown的文檔管理方法ploy_to_wik1.xml腳本文件，將編寫(xiě)完成的.md文件轉(zhuǎn)換成.html文件并發(fā)布至文檔開(kāi)發(fā)項(xiàng)目對(duì)應(yīng)的文件夾中。
[0014]2、文檔展示項(xiàng)目的架構(gòu)布署
說(shuō)明:文檔開(kāi)發(fā)項(xiàng)目中主要是存放與展示各業(yè)務(wù)項(xiàng)目發(fā)布過(guò)來(lái)的.html文檔。文檔的展不主要使用前端s it—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架技術(shù)進(jìn)行布署配置，形成友好的界面交互。
[0015]sit一種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架技術(shù)是將頁(yè)面結(jié)構(gòu)與內(nèi)容相分離的互聯(lián)網(wǎng)風(fēng)格的頁(yè)面布署技術(shù)。在本項(xiàng)目中將頁(yè)面結(jié)構(gòu)分成頂部導(dǎo)航和左側(cè)菜單、右側(cè)內(nèi)容兩部分，利用sit—種基于Markdown的文檔管理方法m一種基于Markdown的文檔管理方法sh的配置文件將兩個(gè)部分組合起來(lái)，形成一個(gè)頁(yè)面。[ΟΟ??]左側(cè)菜單部分利用cooki—種基于Markdown的文檔管理方法緩存技術(shù)，將請(qǐng)求頁(yè)面鏈接的共有屬性data-nam—種基于Markdown的文檔管理方法保存到頁(yè)面的緩存中，以記錄被請(qǐng)求的菜單項(xiàng)使其處于選中狀態(tài)。各業(yè)務(wù)項(xiàng)目的文檔編寫(xiě)者需要在左側(cè)菜單頁(yè)面中配置相應(yīng)的菜單項(xiàng)。
[0017]通過(guò)上面【具體實(shí)施方式】，所述技術(shù)領(lǐng)域的技術(shù)人員可容易的實(shí)現(xiàn)本發(fā)明。但是應(yīng)當(dāng)理解，本發(fā)明并不限于上述的【具體實(shí)施方式】。在公開(kāi)的實(shí)施方式的基礎(chǔ)上，所述技術(shù)領(lǐng)域的技術(shù)人員可任意組合不同的技術(shù)特征，從而實(shí)現(xiàn)不同的技術(shù)方案。
[0018]除說(shuō)明書(shū)所述的技術(shù)特征外，均為本專(zhuān)業(yè)技術(shù)人員的已知技術(shù)。
【主權(quán)項(xiàng)】
1.一種基于Markdown的文檔管理方法，其特征在于包括: 基于Markdown+pandoc技術(shù)，采用腳本發(fā)布的方式，將用戶(hù)編寫(xiě)的.md文檔生成html文件并發(fā)布到文檔開(kāi)發(fā)項(xiàng)目對(duì)應(yīng)的文件目錄中； 文檔開(kāi)發(fā)項(xiàng)目中使用sit—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架進(jìn)行頁(yè)面的布局，將網(wǎng)頁(yè)的內(nèi)容和頁(yè)面結(jié)構(gòu)分離，以達(dá)到頂部和左側(cè)頁(yè)面結(jié)構(gòu)共享； 左側(cè)頁(yè)面結(jié)構(gòu)采用垂直導(dǎo)航的形式來(lái)展現(xiàn)各業(yè)務(wù)模塊文檔的菜單及菜單項(xiàng)；左側(cè)菜單葉子結(jié)點(diǎn)導(dǎo)航至具體文檔的html頁(yè)面，采用cooki—種基于Markdown的文檔管理方法緩存的方式記錄當(dāng)前頁(yè)面，使左側(cè)對(duì)應(yīng)的菜單項(xiàng)為選中狀態(tài)。2.根據(jù)權(quán)利要求1所述的一種基于Markdown的文檔管理方法，其特征在于sit—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh框架技術(shù)是將頁(yè)面結(jié)構(gòu)與內(nèi)容相分離的互聯(lián)網(wǎng)風(fēng)格的頁(yè)面布署技術(shù)，在本項(xiàng)目中將頁(yè)面結(jié)構(gòu)分成頂部導(dǎo)航和左側(cè)菜單、右側(cè)內(nèi)容兩部分，利用sit—種基于Markdown的文檔管理方法m—種基于Markdown的文檔管理方法sh的配置文件將兩個(gè)部分組合起來(lái)，形成一個(gè)頁(yè)面。3.根據(jù)權(quán)利要求1所述的一種基于Markdown的文檔管理方法，其特征在于左側(cè)菜單部分利用cooki —種基于Markdown的文檔管理方法緩存技術(shù)，將請(qǐng)求頁(yè)面鏈接的共有屬性data-nam—種基于Markdown的文檔管理方法保存到頁(yè)面的緩存中，以記錄被請(qǐng)求的菜單項(xiàng)使其處于選中狀態(tài)。
【文檔編號(hào)】G06F17/30GK106095889SQ201610397398
【公開(kāi)日】2016年11月9日
【申請(qǐng)日】2016年6月7日 公開(kāi)號(hào)201610397398.6, CN 106095889 A, CN 106095889A, CN 201610397398, CN-A-106095889, CN106095889 A, CN106095889A, CN201610397398, CN201610397398.6
【發(fā)明人】彭文凈, 吳玉雁
【申請(qǐng)人】浪潮軟件股份有限公司