Skip to content

antony@notes:~/misc$ cat "Docusaurus-Installation.md"

Docusaurus Installation

2024-02-27· misc

Docusaurus Installation

Prerequest

  • 在 Github 上已建立 Repo，並且已將主機的 SSH Public Key 匯入專案中
    • 專案名稱需命名為 : 帳號.github.io

開始安裝 Docusaurus 

## 安裝 node.js 管理工具
## Node.js version 18.0 or above
$ sudo apk add --update npm

## 新建專案
$ npx @docusaurus/init@latest init my-website classic
$ cd my-website/

## 修改設定檔，將 url、organizationName 和 projectName 改成對應的 github 上的資訊
$ nano docusaurus.config.js
(module.exports = {
  url: 'https://nightmare315.github.io'
  organizationName: 'nightmare315', // Usually your GitHub org/user name.
  projectName: 'nightmare315.github.io', // Usually your repo name.
})

## 本機啟動網站測試
$ npm run start -- --host 0.0.0.0

## 部屬到 Github
$ USE_SSH=true GIT_USER=nightmare315 DEPLOYMENT_BRANCH=main npm run deploy
Increase SSH Connection Timeout in LinuxWhat is Reed–Solomon Code?