以下內容基本都是通過訊飛語記來實時翻譯,再copy后編輯排版壤圃,可能存在很多口語話內容陵霉,純屬正常現(xiàn)象伍绳。
不管是不是做開發(fā)踊挠,都遇到很多時候需要做比較,你是怎么樣來保存你的筆記資料呢冲杀?
做開發(fā)其實會涉及到很多的文檔的一些編寫或整理效床,比如說,我們啟動一個項目要怎么展望目標权谁,然后如何規(guī)劃一些細節(jié)剩檀,再然后到項目的分工,項目的產(chǎn)品文檔旺芽,數(shù)據(jù)文檔沪猴,賬號平臺等資料保存卤妒,API文檔的說明,系統(tǒng)開發(fā)后的操作文檔整理等等字币,對了则披,還有過程中參考用到的一些資料,學習到的內容的歸檔等洗出,這些都需要大量的文檔保存士复。
這些所有呢,在最后可能都是通過文檔的方式來保存下來才能更方便自己或者給到別人來閱讀了解翩活,如果按以前的方式都是通過word文檔的方式來處理阱洪,那有個也有好也有壞,好處是我可以隨時發(fā)給別人菠镇,但是壞處是有可能在大批量的內容統(tǒng)一做調整或者目錄結構發(fā)生變化時候冗荸,不是很好的去做變更,這樣導致內容維護起來沒有溯源或者存在很多重復copy利耍。
那有沒有一個方式或工具能夠滿足我們對知識庫的管理蚌本,這個文檔庫一直能保持是最新的一個狀態(tài),或者說我能隨時的追溯到以往的一些記錄隘梨,能夠保證所有的信息都是在最新的程癌,最有用的,而且又是最全面的轴猎。
可能很多人會想到或者已經(jīng)用到例如 印象筆記嵌莉、有道筆記、熊掌記捻脖、Notion 等锐峭,的確這些都是非常優(yōu)秀的工具,但好像又缺了點什么可婶。如果我想我的API文檔能本地隨時保存好沿癞,又能發(fā)布到類似簡書這樣的平臺,又可以單獨拿出來整理成API文檔手冊發(fā)布扰肌,并且這些操作的切換抛寝,其格式還能保存一致,這樣對于別的工具來說可能就不一定那么便利了曙旭。
這里我介紹一套組合拳 Docsify
+ Gitee
首先我們要掌握Markdown語法
markdown語言盗舰,它的語法是非常的簡單,它有統(tǒng)一的標準比類似我們的html這樣的一些語法桂躏,但是那比html更簡單钻趋,它主要是針對在內容格式上的一個最簡約的維護,能保證我們本地和簡書還是其他支持markdown語法的平臺or工具都能統(tǒng)一內容的顯示格式
markdown的語法: http://markdown.p2hp.com/basic-syntax/
其次學會用Dosify 來組織文檔結構
Docsify 是一個動態(tài)生成文檔網(wǎng)站的工具,支持本地編輯的內容文檔的實時預覽
https://docsify.js.org
最后學會用Gitee 保存內容已經(jīng)發(fā)布到Gitee pages以便在線瀏覽
國內的Git庫剂习,保證打開的速度以及能將文檔的撰寫記錄一點一滴都記錄下來
http://gitee.com
這樣的話蛮位,我們自己的知識庫就可以開始搭建起來了较沪。
去新建一個git庫同步到本地后,新建docs 文件夾失仁,
docsify init ./docs
初始化為docsify的根目錄尸曼,得到 _sidebar.md 和index.html 文件,分別為菜單目錄文件和未來web訪問的首頁萄焦。
可以通過
docsify serve ./docs
來本地預覽控轿,對了,編輯的文件工具可以用vscode 或者其他可視化的markdown編寫工具拂封。這里邊設計到如果要圖片上傳的話哦茬射,本地保存,發(fā)布到線上去可能會導致圖片丟失冒签,最好的方式就是圖片都是引用外部鏈接在抛,保持本地和線上體驗一致。[todo]這個未來可以展開下圖片怎么保存和獲取訪問地址萧恕。
這樣我們可以保證內容文檔隨著開發(fā)的進度可以不斷修改補充刚梭。
`