[發(fā)明專利]用于Python編輯器的技術文檔內置實現(xiàn)方法及裝置

在審

• 申請?zhí)枺?/td>: 201811637099.0
• 申請日: 2018-12-29
• 公開（公告）號: CN109669684A
• 公開（公告）日: 2019-04-23
• 發(fā)明（設計）人: 李天馳;孫悅;滕騰
• 申請（專利權）人: 深圳點貓科技有限公司
• 主分類號: G06F8/30
• 分類號: G06F8/30
• 代理公司: 廣東良馬律師事務所 44395
• 代理人: 李良

本發(fā)明公開了一種用于Python編輯器的技術文檔內置實現(xiàn)方法及裝置，方法包括：獲取待內置的技術文檔所對應的資源文件及md文件，將md文件及資源文件放置到vuepress框架下；記錄md文件的結構目錄，在vuepress的配置文件定義發(fā)布信息，將md文件轉譯為html文件，添加相應的功能；定義一個基于根目錄的路徑調用資源的資源調用協(xié)議；在elecrton中注冊資源調用協(xié)議，注冊完成后，技術文檔內置完成。本發(fā)明實施例使得vuepress能夠在electron中離線使用，正常加載資源，保持一切功能正常，使得用戶能夠十分方便的查看技術手冊。

技術領域

本發(fā)明涉及通信技術領域，尤其涉及一種用于Python編輯器的技術文檔內置實現(xiàn)方法及裝置。

背景技術

VuePress由兩部分組成：一部分是支持用Vue開發(fā)主題的極簡靜態(tài)網站生成器，另一個部分是為書寫技術文檔而優(yōu)化的默認主題。它的誕生初衷是為了支持Vue及其子項目的文檔需求。但是隨著技術的發(fā)展，應用框架已經不滿足于Vue了，基于React的技術結合Electron客戶端的產品也是非常有市場的，但現(xiàn)有的vuepress所產生技術文檔是一個單獨的技術文檔，無法內置到electron客戶端當中，為用戶查看技術手冊帶來不便。

因此，現(xiàn)有技術還有待于改進和發(fā)展。

發(fā)明內容

鑒于上述現(xiàn)有技術的不足，本發(fā)明的目的在于提供一種用于Python編輯器的技術文檔內置實現(xiàn)方法及裝置，旨在解決現(xiàn)有技術中的vuepress所產生技術文檔無法內置到electron客戶端當中的問題。

本發(fā)明的技術方案如下：

一種用于Python編輯器的技術文檔內置實現(xiàn)方法，所述方法包括：

獲取待內置的技術文檔所對應的資源文件及md文件，將md文件及資源文件放置到vuepress框架下；

記錄md文件的結構目錄，在vuepress的配置文件定義發(fā)布信息，將md文件轉譯為html文件，添加相應的功能；

定義一個基于根目錄的路徑調用資源的資源調用協(xié)議；

在elecrton中注冊資源調用協(xié)議，注冊完成后，技術文檔內置完成。

可選地，所述獲取待內置的技術文檔所對應的資源文件及md文件，將md文件及資源文件放置到vuepress框架下前，包括：

接收用戶指令對待內置的技術文檔所對應的資源文件及md文件進行撰寫。

可選地，所述記錄md文件的結構目錄，包括：

在vuepress下的locales中記錄每個md文件的結構目錄。

可選地，所述在vuepress的配置文件定義發(fā)布信息，包括：

在vuepress的config配置文件中定義文件的發(fā)布地址，輸出的文件夾和構建用的根目錄信息。

可選地，所述將md文件轉譯為html文件，添加相應的功能，包括：

將md文件轉譯為html文件，通過js添加相應的功能，生成技術文檔對應的靜態(tài)網站。

可選地，所述定義一個基于根目錄的路徑調用資源的資源調用協(xié)議，包括：

定義一個資源調用協(xié)議，所述資源調用協(xié)議用于使得所有文件資源都基于某個根目錄的路徑進行調用。

可選地，所述在elecrton中注冊資源調用協(xié)議，注冊完成后，技術文檔內置完成，包括：

在elecrton中注冊資源調用協(xié)議，注冊協(xié)議后，elecrton獲取到文件讀取的請求；