JetBrains Writerside是一款功能強大好用的文檔編輯創作工具,在軟件中為各位用戶們帶來了諸多便利的功能,幫助用戶更為高效的進行文檔的創建、編寫、組織等操作。軟件中結合了Markdown和XML,還提功了即時檢查等功能,方便用戶的使用。
軟件功能
【創建文檔】
在IDEA中打開在JetBrains Writerside工具窗口,打開之后有引導頁,點擊Add documentation按鈕,然后點擊To Current Project,選擇New,然后我們添加實例名稱(類似文檔目錄名稱),之后生成即可,然后會自動生成幫助實例文檔
【創建主題】
有了帶幫助實例的文檔項目之后,就可以右鍵目錄向其中添加主題并開始編寫內容,目前有5種Markdown主題和5種XML主題。
新建MD格式主題,并在其下面新建兩個二級主題,左側編寫,右側預覽效果,并且可以通過拖動更改主題的層次結構。
【構建網站】
在Writerside工具窗口中上方有個按鈕,單擊”Open in Browser“或“Save as ZIP Archive”
直接本地打開網站選”Open in Browser“,文檔無報錯即可在瀏覽器中瀏覽文檔了
如果需要發布可以選擇“Save as ZIP Archive”生成壓縮文件,再部署到服務器中訪問
軟件特色
文檔即代碼管道,使用單一創作環境,免除對多種工具的需求。借助內置 Git UI、集成式構建工具、自動化測試以及現成和可自定義的布局,專注于您的內容。
結合 Markdown 和 XML,現在,您可以將 Markdown 與語義標記的優勢相結合。選擇一種格式,或使用語義特性和元素、Mermaid 圖和 LaTeX 數學公式豐富 Markdown。
文檔質量自動化,通過編輯器中的超過 100 項即時檢查以及實時預覽和構建期間的測試確保文檔質量和完整性。
實時預覽,預覽顯示的文檔與讀者將看到的完全相同。在 IDE 中預覽單個頁面,或在瀏覽器中打開整個幫助網站而不運行構建。
單一來源,從較小的內容塊到整個主題或目錄部分,重用一切。靈活使用篩選器和變量。為復雜標記元素使用預定義模板,或者配置您自己的模板。
REST API 文檔生成,創建用戶文檔和 API 參考時無需在不同工具之間跳轉?,F在,您可以將 API 文檔合并到幫助網站中,以相同的布局發布,并通過手動編寫的內容補充自動生成的參考。
網友評論