Writerside是JetBrains出的一個技術文檔工具,既能用在JetBrains IDE上,也能單獨用。它能幫你輕松寫、建、測、發技術文檔,像產品說明、API參考、開發指南等都能搞定。
特點:
- 文檔即代碼:它讓你像管代碼一樣管文檔,有Git UI和集成構建工具。
- Markdown和XML一起用:在Writerside里,Markdown和XML都能用,還能加語義屬性或元素,Markdown也能輕松轉XML。
- 文檔質量檢查:它能自動檢查100多項內容,比如斷鏈、丟資源等,保證文檔沒問題。
- 實時預覽:你寫的時候,它就能預覽最后效果,不用等構建完。
- 內容重用:維護一個內容源,就能重復使用內容塊、主題等,提高效率。
- API文檔生成:寫用戶文檔和API參考超方便,不用換來換去。
- 多語言:它支持25種以上語言,包括英語、德語等,還有拼寫和語法檢查。
安裝與啟動
需要科學上網,資源也無法上傳至CSDN,需要的可以評論留郵箱,注明版本需求(Windows、Windows Arm64、Linux、MacOS)
EAP版本是免費公測版,后續要不要收費暫不清楚,感覺是要的,所以注意不要和平臺綁定太死,它是XML和MD都支持
盡量選擇使用MD語法,后面就算不用了,到時候遷移起來也不會那么費勁
- 下載安裝程序Writerside,并運行安裝
- 安裝完成后,啟動Writerside軟件。
- 切換成中文界面
- 切換界面風格,看自己的習慣切換,因為用慣了各種開發工具,因此還挺喜歡經典UI模式的,但是新版UI的中文支持度更好…
經典UI,傳統工具類軟件風格
新UI:很有互聯網當下的簡約設計感,什么都收起來…
創建新項目
-
在主菜單中選擇
文件-新建/New Project
。 -
在彈出向導中,設置存儲位置
-
創建
工程,新手可以創建更多的模板工程,學一學里面提供的語法規則
創建和編輯內容
如下所示,就是創建好一個工程了。
-
添加新主題
-
推薦創建MD格式文件,除了文本性描述內容,如果要插入圖片或者視頻,直接在文本編輯區域復制粘貼,它會自動識別幫你寫好語法,多試一試就熟悉了,還是很方便的
發布
新版在對應這個位置也有一個這樣的圖標
注意這就是打包,不是文件里面的導出
Web Archive是將當前工程直接打包成可發布的Html包
PDF顧名思義就是直接生成一份離線手冊,這個暫時還無法應對過于復雜的手冊,視頻什么的會完全丟失,連截圖都沒有
-
點擊導出按鈕
-
設置界面,暫時不熟悉就不用管,直接運行輸出就好
-
下方界面會彈出一串輸出
-
點擊Zip就可以跳轉到輸出目錄,解壓就是一個完整的Html離線包
-
解壓后,使用VsCode打開文件夾,通過liveshare插件就可以查看這個生成的網頁了(這個教程網上很多,我就不贅述了)