Docusaurus2 快速建站,發布 GitHub Pages
- 2021 年 1 月 14 日
- 筆記
- docusaurus, github-pages, Markdown, Serverless, 前端
Docusaurus2 可快速搭建文檔、部落格、官網等網站,並發布到 GitHub Pages, Serverless 等。
我們只需 Markdown 寫寫內容就行,也可直接編寫 React 組件嵌入。而 SEO、搜索、版本等都友好支援了。
另外重要的一點是此項目是 Facebook 開源維護的,他們自己也在用,所以品質、長久性能有所保證。
前提準備
- 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
訪問 //localhost:3000/start-docusaurus2/ 本地地址。
發布到 GitHub Pages
修改 docusaurus.config.js
:
module.exports = {
title: 'My Site',
tagline: 'The tagline of my site',
url: '//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
訪問 //ikuokuo.github.io/start-docusaurus2/ 在線地址。
發布到 Serverless
GoCoding 個人實踐的經驗分享,可關注公眾號!