爲開源項目而生的開源項目——做開源項目的專屬夥伴Docusaurus。
介紹
作爲程序員都知道有一個叫Github的網站，上面有着成千上萬的開源項目，作爲開源項目的貢獻者們，如果想要獲得更多的關注，那麼一個好的項目文檔或者使用文檔無疑是必須的，這樣才能讓大家更容易的去了解項目本身，以及如何使用，Docusaurus可以爲你的開源項目構建一個專屬於項目本身的靜態文檔網站，這一切都變得簡單起來!
Github
https://github.com/facebook/docusaurus
作爲爲開源項目而生的開源項目，docusaurus獲得了13k+的stars，受歡迎程度很高！也是一直處於穩步增長趨勢！其V2版本也將提上日程，可以到Github上提供意見和反饋!
相關特性
由Markdown提供支持
節省時間並專注於項目的文檔。只需使用Markdown 和Docusaurus 編寫文檔和博客文章，它們就會發布一組靜態html文件，可供使用。
使用React構建
通過重用React 擴展或自定義項目的佈局。可以在重複使用相同的頁眉和頁腳的同時擴展文檔庫。
國際化
本地化已預先配置。使用Crowdin可以將你的文檔翻譯成70多種語言。
文檔版本控制
文檔版本控制可幫助你使文檔與項目版本保持同步。
文件搜索
使你的社區輕鬆地在文檔中找到他們所需的內容。很輕鬆的支持Algolia文檔搜索。
快速設置
快速啓動並運行，而不必擔心網站設計。
開發和部署
使用隨附的實時服務器進行設計和文檔更改。使用腳本或與CircleCI之類的持續集成，將你的網站手動發佈到GitHub頁面或其他靜態文件主機。
網站功能
Docusaurus當前提供支持以幫助你的網站使用翻譯，搜索和版本控制，以及一些其他特殊文檔markdown特性。如果你有實用功能的想法，可隨時在GitHub上貢獻力量！
誰正在使用Docusaurus？
Docusaurus正在爲這些項目建立網站，其中不乏很多熱門的開源項目：
快速開始
Docusaurus從頭開始設計，易於安裝，可用來快速啓動和運行您的網站，Docusaurus創建了一個簡單的腳本，它將設置所有基礎架構：
1、確保您已安裝最新版本的Node。我們還建議您也安裝Yarn。
必須Node> = 8.x和Yarn> = 1.5上。
2、創建一個項目（如果不存在），然後將目錄更改爲該項目的根目錄。將在此目錄中創建文檔。根目錄可能包含其他文件。Docusaurus安裝腳本將創建兩個新目錄：docs和website。
通常，現有的或新建的GitHub項目將成爲您的Docusaurus站點的位置，但是使用Docusaurus並不是必須的。
3、運行Docusaurus安裝腳本：
npx docusaurus-init
如果沒有Node 8.2+，或者希望全局安裝Docusaurus，請運行yarn global add docusaurus-init或npm install --global docusaurus-init。之後，運行docusaurus-init。
4、驗證安裝
除了以前存在的文件和目錄，根目錄現在將包含類似於以下內容的結構：
5、運行示例網站
按照“安裝”部分的說明運行Docusaurus初始化腳本docusaurus-init之後，擁有一個可運行的示例網站，作爲網站的基礎。運行起來：
1、cd website
2、在網站目錄中，使用yarn start或npm start運行本地Web服務器。如果尚未自動打開示例站點，則將其加載到本地3000端口。如果已經使用端口3000，則將使用另一個端口。
應該會在Web瀏覽器中看到示例站點。還有一個LiveReload服務器正在運行，對網站目錄中的文檔和文件所做的任何更改都將導致頁面刷新。會選擇隨機生成的默認和輔助主題顏色。
6、設置代理
如果在設置代理，則需要針對開發服務器請求將其禁用。可以使用NO_PROXY環境變量來完成。
SET NO_PROXY=localhost
yarn start (or npm run start)
7、更新您的Docusaurus版本
在安裝Docusaurus之後的任何時間，都可以通過進入網站目錄並鍵入
yarn outdated docusaurus或npm outdated docusaurus
來檢查當前版本的Docusaurus，會看到如下內容：
8、可以通過以下方式更新到最新版本的Docusaurus：
yarn upgrade docusaurus --latest 或者 npm update docusaurus
以上就是入門級別的Docusaurus安裝使用方式，詳細的安裝使用以及發佈部署等都可以在官方文檔中找到詳細的說明，感興趣的小夥伴可以參閱文檔，文檔本身就提供了對應的中文版，Enjoy it！
總結
Docusaurus是一個專門爲開源項目而生的開源項目文檔管理項目，功能豐富，界面美觀，可以作爲靜態文檔的構建工具也可以當作博客一樣使用它！
更多幹貨資源請關注作者的專欄。
留言點贊關注，我們一起分享AI學習與發展的乾貨。