使用docusaurus搭建网站，并部署到github

Docusaurus 本质上是一组 npm 包。Node.js v16.14 或以上版本（你可以运行 node -v 命令查看版本号）。

1、使用命令行工具快速简单地安装 Docusaurus 并搭建网站框架，使用 classic 模板来快速上手,它会创建一个包含模板文件的新目录：

npx create-docusaurus@latest my-website classic

你也可以用 --typescript 选项来使用模板的 TypeScript 变种。更多详情请查看 Typescript 支持。

npx create-docusaurus@latest my-website classic --typescript

2、安装成功后运行项目，默认情况下，浏览器会自动打开 http://localhost:3000 的新窗口。

npm run start 或者 yarn start

3、构建

Docusaurus 是一款现代化的静态网页生成器。我们需要将网站生成为静态内容，并上传到网络服务器，才能被其他人访问。 要构建站点，请使用以下命令：

npm run build 或者 yarn run build

会生成 build 目录，随后可以被上传到 GitHub Pages、Vercel、Netlify 等静态网页托管服务。

4、以github为例：部署到Github Pages

（1） 创建一个本地仓库，并在github创建一个远程仓库

          命名一般为自己的：xxx(账户名).github.io，点击创建

扫描二维码关注公众号，回复： 15457024 查看本文章

（2）将本地仓库或者新仓库和github仓库建立连接

        注意：本地仓库和远程仓库建立连接的时候需要注意的点

// 这里不使main分支，直接改为gh-pages
git branch -M gh-pages
git push -u origin gh-pages

（3）docusaurus下载的模板中docusaurus.config.js文件配置 

module.exports = {
  // ...
  url: 'https://cfgjfy.github.io', // 你的网站URL（刚所创建的github仓库名）
  baseUrl: '/',
  projectName: 'cfgjfy.github.io', // 刚所创建的github仓库名
  organizationName: 'cfgjfy', // github账户名
  deploymentBranch: 'gh-pages', // 部署到的分支名
  // ...
};

（4）部署

     在git bash中输入以下命令

GIT_USER='github账户名' yarn deploy

说明：执行上面命令，可以一步完成克隆、构建、提交。不用我们手动执行build命令，再部署到某个托管服务上，方便了很多。

（5）点击仓库的setting----->pages

可以通过上面那个网址访问静态网页。

关于网站内容的具体配置，这里就不阐述了，可以看官网：

介绍 | Docusaurus