Docusaurus2 可快速搭建文件、部落格、官網等網站,併發布到 GitHub Pages, Serverless 等。
我們只需 Markdown 寫寫內容就行,也可直接編寫 React 元件嵌入。而 SEO、搜尋、版本等都友好支援了。
另外重要的一點是此專案是 Facebook 開源維護的,他們自己也在用,所以質量、長久效能有所保證。
- 程式碼: https://github.com/ikuokuo/start-docusaurus2
- 演示: https://ikuokuo.github.io/start-docusaurus2/ ?
前提準備
- Node.js version >= 10.15.1
- Yarn version >= 1.5
❯ node -v
v12.18.4
❯ yarn version
yarn version v1.22.10
建立專案
# npx @docusaurus/init@latest init [name] [template]
npx @docusaurus/init@latest init my-website classic
執行輸出:
Success! Created my-website
Inside that directory, you can run several commands:
yarn start
Starts the development server.
yarn build
Bundles the app into static files for production.
yarn deploy
Publish website to GitHub pages.
We suggest that you begin by typing:
cd my-website
yarn start
Happy hacking!
執行應用
cd my-website/
yarn start
訪問 http://localhost:3000/start-docusaurus2/ 本地地址。
釋出到 GitHub Pages
修改 docusaurus.config.js
:
module.exports = {
title: 'My Site',
tagline: 'The tagline of my site',
url: 'https://ikuokuo.github.io',
baseUrl: '/start-docusaurus2/',
onBrokenLinks: 'throw',
favicon: 'img/favicon.ico',
organizationName: 'ikuokuo',
projectName: 'start-docusaurus2',
...
};
釋出:
cd my-website/
GIT_USER=ikuokuo USE_SSH=true yarn deploy
訪問 https://ikuokuo.github.io/start-docusaurus2/ 線上地址。
釋出到 Serverless
GoCoding 個人實踐的經驗分享,可關注公眾號!