為什麼要使用Docusaurus Docusaurus 是 Facebook 專門為開源項目開發者提供的一款易於維護的靜態網站創建工具,使用 Markdown 即可更新網站。構建一個帶有主頁、文檔、API、幫助以及博客頁面的靜態網站,只需5分鐘。 Docusaurus 是一個靜態站點生成器。它構建了 ...
為什麼要使用Docusaurus
Docusaurus 是 Facebook 專門為開源項目開發者提供的一款易於維護的靜態網站創建工具,使用 Markdown 即可更新網站。構建一個帶有主頁、文檔、API、幫助以及博客頁面的靜態網站,只需5分鐘。
Docusaurus 是一個靜態站點生成器。它構建了一個具有快速客戶端導航的單頁應用程式,利用React的全部功能使您的站點具有交互性。它提供開箱即用的文檔功能,但可用於創建任何類型的網站(個人網站、產品、博客、營銷登錄頁面等)。
通過本教程中,你將從頭開始構建自己的應用,分別使用Docusaurus CLI 和 雲開發平臺
Docusaurus-CLI 快速搭建項目
一、搭建本地開發環境
-
Docusaurus 需要 Node.js版本 >= 14 或以上(可以通過運行檢查node -v)。您可以使用nvm在安裝的單台機器上管理多個 Node 版本。安裝 Node.js 時,建議您選中所有與依賴項相關的覆選框。
-
npm 包管理器 因為我們通常都會使用Docusaurus 提供的腳手架搭建項目結構,所以要下載並安裝 npm 包。本指南使用 npm 客戶端命令行界面,該界面預設安裝在 Node.js。要檢查你是否安裝了 npm 客戶端,請在終端視窗中運行 npm -v 。
-
Docusaurus 本質上是一組 npm包。
二、創建新的初始應用
- 安裝 Docusaurus 最簡單的方法是使用命令行工具來幫助您搭建 Docusaurus 骨架網站。您可以在新的空存儲庫或現有存儲庫中的任何位置運行此命令,它將創建一個包含腳手架文件的新目錄。
npx create-docusaurus@latest my-website classic
- 新建完成後,指定文件夾的目錄如下:
my-website
├── blog
│ ├── 2019-05-28-hola.md
│ ├── 2019-05-29-hello-world.md
│ └── 2020-05-30-welcome.md
├── docs
│ ├── doc1.md
│ ├── doc2.md
│ ├── doc3.md
│ └── mdx.md
├── src
│ ├── css
│ │ └── custom.css
│ └── pages
│ ├── styles.module.css
│ └── index.js
├── static
│ └── img
├── docusaurus.config.js
├── package.json
├── README.md
├── sidebars.js
└── yarn.lock
三、啟動應用伺服器
進入工作區目錄,並啟動這個應用。
cd my-website
npm run start
npm run start 命令會構建本應用、啟動開發伺服器、監聽源文件,並且當那些文件發生變化時重新構建本應用,
也會打開瀏覽器,並訪問 http://localhost:3000/ 。
你會發現本應用正運行在瀏覽器中。
雲平臺一鍵部署Docusaurus
一、創建環境
想要一鍵部署Docusaurus,需要以下賬號和服務:
- Github賬號 (https://github.com/),
- 阿裡雲賬號,並使用阿裡雲賬號登錄雲開發平臺 (https://workbench.aliyun.com/),為保證最好的使用體驗,請使用Chrome瀏覽器。開通OSS服務。
- 未開通阿裡雲OSS的用戶,點擊鏈接 (https://workbench.aliyun.com/product/open?code=oss)開通OSS服務。OSS開通免費,有一定的免費額度,超過額度之後按量付費。
二、創建Docusaurus應用
- 創建前端應用。打開快速開始 https://workbench.aliyun.com/app,找到 Docusaurus 點擊創建「創建應用」按鈕。
- 雲資源訪問授權。如果您之前沒有使用過雲開發平臺,會出現雲資源授權管理的選項,往下拉出現直至同意授權的字樣,點擊「同意授權」後出現授權成功,點擊進入「下一步」。
- 綁定Github賬號。授權完成後選擇來源倉庫為Github,按照提示點擊去綁定,綁定GitHub帳號,登錄後並點擊Authorize Aliyunworkben允許雲開發平臺構建、發佈你的GitHub代碼為可訪問的網站。
- 選擇fork好的“Docusaurus”代碼倉庫。選擇第一步中的代碼倉庫,主幹分支,並點擊下一步。主幹分支一般指的是代碼的master或main等分支。
填寫基本信息,完成創建。填寫基本信息並點擊「完成」。成功後進入到應用詳情和部署界面。
三、在日常環境部署
- 一鍵進行應用部署。在應用詳情頁面點擊日常環境的「部署」按鈕進行一鍵部署,部署狀態變成綠色已部署以後可以點擊訪問部署網站查看效果。
- 訪問Docusaurus網站。日常環境的測試功能變數名稱也是可以訪問的,點擊訪問已部署網站按鈕會出現一個彈出,點擊彈出上的立即訪問就能夠訪問已經部署好的站點了。在部署完成後,可以繼續本地編碼,並將代碼push到應用的“基本信息”中對應的代碼倉庫內。
多端應用一鍵上雲
現如今身處在隨時會到來新狀況的大環境下,做好自己便是在不安中樹立了一顆屹立不倒的松樹。作為開發者們每天都要面臨新的代碼、應用,保持隨時學習的狀態和能力也可讓自己多一份安穩。阿裡云云開發平臺的初衷是為每一位開發者提供免費、便捷的雲上研發工作平臺,通過學習與實操演練兩種模式,從入門到精通快速上手Serverless和雲開發技術。0門檻全雲端開發、隨時隨地線上協同、業界領先Serverless架構、行業應用一件初始化等特性也通過每次的實踐伴隨著你、我。
雲原生應用、主機應用部署、前端應用部署三大板塊的提供,供開發者們找到最合適自己神器,令開發工作事半功倍。其中滿足IoT語音技能、小程式、H5應用等開發者低門檻應用開發的需求;也支持代碼編譯部署到ECS主機伺服器的場景,幫助用戶管理傳統主機應用的能力;讓前後端應用能夠更高效地協同。平臺將持續與開發者一起共同成長,幫忙開發者更好、更快以及更低成本的開發,多端的應用更加快速的上雲。
【特別活動】雲開發2周年,0門檻部署上線4款熱門游戲,游戲暢玩還有AirPods耳機、筋膜槍等8種獎品任你挑啦,立即參與:https://workbench.aliyun.com/activities/bday