[發明專利]一種基于Markdown標記語言的文檔生成方法及系統

在審

• 申請號: 202110606259.0
• 申請日: 2021-05-27
• 公開（公告）號: CN113342321A
• 公開（公告）日: 2021-09-03
• 發明（設計）人: 俞建東
• 申請（專利權）人: 寧波檸清信息科技有限公司
• 主分類號: G06F8/30
• 分類號: G06F8/30;G06F8/41;G06F8/73
• 代理公司: 暫無信息
• 代理人: 暫無信息

本發明涉及計算機技術領域，公開了一種基于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文檔鏈接以文檔名稱進行命名。