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

【軟件功能】

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

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

　　文檔質量自動化，通過編輯器中的超過 100 項即時檢查以及實時預覽和構建期間的測試確保文檔質量和完整性。

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

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

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

【創(chuàng)建文檔】

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

【創(chuàng)建主題】

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

　　新建MD格式主題，并在其下面新建兩個二級主題，左側編寫，右側預覽效果，并且可以通過拖動更改主題的層次結構。

【構建網(wǎng)站】

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

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

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

【Nginx 部署】

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