創建軟件時最重要的任務之一就是文檔,不幸的是,對於那些從事這項工作的人來說,有時候看起來很乏味,但是對於任何人來說,好的文檔可以成為任何工具成功的關鍵並不是什麼秘密,因為提供給用戶的幫助,幫助他們了解應用程序的正確操作或提供給其他開發人員的信息以改善應用程序。
有很多優秀的應用程序可以使我們以簡單的方式來記錄項目,有些傾向於提供超出我們真正想要的功能,有些則需要復雜的安裝, 記錄項目的工具 符合且非常易於使用和安裝的Docusaurus。
什麼是Do龍?
cus龍 是一個項目 構建,實施和維護開源工具Web文檔,它允許使用該語言 降價 以相同的方式編寫文檔,以稍後將其發佈為html網站,該工具允許我們使用React擴展和自定義文檔網站的設計。
通常,由Facebook編程團隊開發的開放源代碼工具使我們能夠輕鬆創建美觀而輕鬆的網站,在這裡我們可以正確顯示任何項目的文檔。
該工具具有用於正確版本化文檔的功能,高級搜索引擎,可以實時記錄和重新設計我們的文檔站點的功能,與翻譯的集成以及許多其他功能,這些功能將幫助您減少對文檔編制的擔心,而不必擔心文檔製作過程更加輕鬆,並且效果更加令人滿意。
在其開發者分發的以下gif文件中可以看到Docusaurus的易於使用
如何安裝Docusaurus?
Docusaurus的主要目標是成為記錄在github上託管的開源應用程序的權威工具,因此在此平台上安裝和運行您的文檔網站確實非常容易。
要開始在Github上享受Docusaurus,只需按照開發團隊指示的步驟進行,我們在下面引用:
- 轉到GitHub存儲庫目錄的根目錄,您將在其中創建文檔並運行以下命令:
yarn global add docusaurus-init
ornpm install --global docusaurus-init
docusaurus-init
最終結果將是創建文件和目錄結構,如下所示:
嘗試有趣的錯誤!