项目简介
本项目基于 Docusaurus 2 框架构建,是一个个人静态网站模板。它能帮助有需求的用户快速搭建静态网站,也便于实验室小伙伴共同构建实验室知识库。模板已完成基本的站点结构和样式配置,用户填充内容后即可快速部署个人网站。
项目的主要特性和功能
- 基于 Docusaurus 2 框架,性能出色且可扩展性强。
- 包含博客和文档页面,方便展示个人文章与知识。
- 配置环境简单,只需安装 Node.js 和 Yarn 便可开始搭建。
- 自定义配置便捷,修改
docusaurus.config.js
文件即可实现站点信息配置。
安装使用步骤
假设用户已下载本项目的源码文件:
1. 安装依赖:在项目根目录下运行 yarn install
命令安装所需依赖。
2. 本地预览:执行 yarn start
命令启动本地服务器,预览站点效果。
3. 自定义配置:根据自身需求修改 docusaurus.config.js
文件,配置站点信息、菜单、导航等内容。
4. 编写内容:在 blog
目录下创建博客文章,在 docs
目录下创建文档页面。
5. 构建站点:执行 yarn build
命令生成静态内容。
6. 配置 docusaurus.config.js
中的相关内容:
js
baseUrl: '/projectName/',
projectName: 'projectName', // Usually your repo name.
配置 Git Action 实现自动部署额外步骤
- 生成新的 SSH key:
ssh-keygen -t rsa -C "user@email.com"
,将id_rsa_action.pub
添加到仓库的settings -> Deploy keys
并勾选Allow write access
,将id_rsa_action
添加到仓库的settings -> Secrets
,Name
设置为GH_PAGES_DEPLOY
。yml env: USE_SSH: true GIT_USER: user run: | git config --global user.email "user@email.com" git config --global user.name "user" if [ -e yarn.lock ]; then yarn install --frozen-lockfile elif [ -e package-lock.json ]; then npm ci else npm i fi npx docusaurus deploy
部署到 Vercel 额外步骤
参考: - 使用 Docusaurus 搭建个人博客 - 使用 Docusaurus 搭建个人知识库
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】