Writerside允許開發(fā)人員和編寫人員在產(chǎn)品文檔、API 參考、開發(fā)人員指南、教程和操作方法方面進(jìn)行協(xié)作；基于人工智能的拼寫檢查和語法糾正工具支持超過 25 種語言，包括英語、德語、西班牙語和中文，基于 IntelliJ 平臺(tái)的 JetBrains IDE，開發(fā)人員可使用它編寫、構(gòu)建、測(cè)試和發(fā)布技術(shù)文檔，可以作為 JetBrains IDE 中的插件使用，也可以作為獨(dú)立工具使用。

【軟件功能】

　　文檔即代碼管道，使用單一創(chuàng)作環(huán)境，免除對(duì)多種工具的需求。借助內(nèi)置 Git UI、集成式構(gòu)建工具、自動(dòng)化測(cè)試以及現(xiàn)成和可自定義的布局，專注于您的內(nèi)容。

　　結(jié)合 Markdown 和 XML，現(xiàn)在，您可以將 Markdown 與語義標(biāo)記的優(yōu)勢(shì)相結(jié)合。選擇一種格式，或使用語義特性和元素、Mermaid 圖和 LaTeX 數(shù)學(xué)公式豐富 Markdown。

　　文檔質(zhì)量自動(dòng)化，通過編輯器中的超過 100 項(xiàng)即時(shí)檢查以及實(shí)時(shí)預(yù)覽和構(gòu)建期間的測(cè)試確保文檔質(zhì)量和完整性。

　　實(shí)時(shí)預(yù)覽，預(yù)覽顯示的文檔與讀者將看到的完全相同。在 IDE 中預(yù)覽單個(gè)頁面，或在瀏覽器中打開整個(gè)幫助網(wǎng)站而不運(yùn)行構(gòu)建。

　　單一來源，從較小的內(nèi)容塊到整個(gè)主題或目錄部分，重用一切。靈活使用篩選器和變量。為復(fù)雜標(biāo)記元素使用預(yù)定義模板，或者配置您自己的模板。

　　REST API 文檔生成，創(chuàng)建用戶文檔和 API 參考時(shí)無需在不同工具之間跳轉(zhuǎn)。現(xiàn)在，您可以將 API 文檔合并到幫助網(wǎng)站中，以相同的布局發(fā)布，并通過手動(dòng)編寫的內(nèi)容補(bǔ)充自動(dòng)生成的參考。

【創(chuàng)建文檔】

　　在IDEA中打開在Writerside工具窗口，打開之后有引導(dǎo)頁，點(diǎn)擊Add documentation按鈕，然后點(diǎn)擊 To Current Project，選擇 New，然后我們添加實(shí)例名稱（類似文檔目錄名稱），之后生成即可，然后會(huì)自動(dòng)生成幫助實(shí)例文檔

【創(chuàng)建主題】

　　有了帶幫助實(shí)例的文檔項(xiàng)目之后，就可以右鍵目錄向其中添加主題并開始編寫內(nèi)容，目前有5種 Markdown 主題和5種 XML 主題。

　　新建MD格式主題，并在其下面新建兩個(gè)二級(jí)主題，左側(cè)編寫，右側(cè)預(yù)覽效果，并且可以通過拖動(dòng)更改主題的層次結(jié)構(gòu)。

【構(gòu)建網(wǎng)站】

　　在Writerside工具窗口中上方有個(gè)按鈕，單擊”Open in Browser“或“Save as ZIP Archive”

　　直接本地打開網(wǎng)站選”Open in Browser“，文檔無報(bào)錯(cuò)即可在瀏覽器中瀏覽文檔了

　　如果需要發(fā)布可以選擇“Save as ZIP Archive”生成壓縮文件，再部署到服務(wù)器中訪問

【Nginx 部署】

　　將上面的壓縮包解壓到服務(wù)器的目錄/usr/share/nginx/writerside 中，下面是我的 nginx.conf 配置，大家可以酌情參考