先說下選擇Markdown編輯器的原因,我們進行平臺開發,需要很多的操作手冊和API文檔,要在網站中展示出來就需要是HTML格式的文件,但是由於內容很多,不可能全部由技術人員進行文檔的編寫,如果是只有文檔操作經驗的人來做就會出現很麻煩的情況。 最初,我們先用試著用word來寫,再轉換成HTML文件保 ...
先說下選擇Markdown編輯器的原因,我們進行平臺開發,需要很多的操作手冊和API文檔,要在網站中展示出來就需要是HTML格式的文件,但是由於內容很多,不可能全部由技術人員進行文檔的編寫,如果是只有文檔操作經驗的人來做就會出現很麻煩的情況。
最初,我們先用試著用word來寫,再轉換成HTML文件保存,但是這樣存在幾個問題:1、轉換出來的文件標簽和樣式十分的雜亂和冗餘,有太多無用的標簽,後期要修改樣式也十分不容易;2、圖片無法保存,在word文檔中插入的圖片路徑是固定的物理路徑,或是與文檔一起存儲的,當文檔轉換成HTML文件並放在網站伺服器上使用時,圖片的路徑就發生了變化,如果再去調整圖片就十分麻煩;3、關於圖片還有種解決的辦法,word可以保存為htm格式,這種格式是將圖片和文字一同保存在一個文件的方法,但是最後的結果是只有IE可以識別這種格式,在Chrome里都是亂碼,所以最後同樣作罷。
在一些編寫API文檔的專門網站中,我偶然看到markdown編輯器,向經理提了一下,他說之前就考慮這個,所以就由我來開發(好大一個坑)。
網上找到的開源markdown編輯器中,我第一個看中的是Editor.md,發現用的人很多,相關的帖子也不少,所以最開始是用這個開發的,最初在單獨的網頁上實現也很快,但是拿到框架里就出現了一些相容性問題很難解決,並且需要引用很多文件,與我們的需求相比,它太臃腫了,功能不夠簡潔,而且,最關鍵的問題是,我找到GitHub上發現,這個編輯器已經有兩三年沒有更新了,很多問題都沒有好的解決方法,所以現在的用戶也不多,網上有的都是遺存的帖子,之前沒有註意到發帖時間。。。
然後就繼續尋找,後面的詳細過程記不太清楚了,總之是發現現在需要用markdown編輯器開發者幾乎都是自己開發,而我又不具備這種能力,最終是找到了markdown plus這個比較輕量級的編輯器,開發者最初也是遇到和我一樣的問題,從開始用Editor.md到最後自己開發,所以他在開發過程中儘力使代碼簡潔,並且最近幾個月還在更新,在這個過程中還推出了Windows版和Mac版,十分推薦。另外CSDN上的markdown編輯器中標註使用的StackEdit也非常好用,有獨立的網頁版本,同時代碼也是開源的,不過我還不太會用,下一節就是具體記錄相關的踩坑過程,使用Git、yarn之類的工具的情況。
在查找這些相關資料和編輯器的過程中,我能學到很多細微的知識,雖然花了很多時間,走了很多彎路,但也開始慢慢地掌握程式員學習進步的基本,希望以後能更有效率地開發。