项目简介
本项目是基于Docusaurus框架搭建的知识库系统,用于记录各类知识并分享给有需要的人。系统包含编程、数据结构、计算机网络等多领域的知识内容,通过清晰的目录结构组织,方便用户查找和学习。
项目的主要特性和功能
- 自动化构建与部署:借助
build.yml
实现main分支自动构建静态网站并部署至html分支,保证内容及时更新。 - 定期内容爬取与推送:
algolia.yml
可在每周三凌晨02:00自动爬取内容并推送至Algolia,便于用户搜索。 - 丰富的知识分类:知识涵盖博客、编程、职业发展、组织相关等多个类别,满足不同用户需求。
- 多分支管理:设有main主分支、dev开发分支和phone移动分支,方便开发与管理。
- 社区贡献支持:欢迎用户Fork项目进行贡献,还提供指导纠错,促进知识完善和更新。
安装使用步骤
前提条件
假设用户已下载本项目的源码文件,且系统已安装Node.js和npm。
安装依赖
在项目根目录下,打开终端并执行以下命令安装项目所需的依赖:
bash
npm install
本地运行
依赖安装完成后,执行以下命令启动本地开发服务器:
bash
npm run start
启动成功后,在浏览器中访问指定地址即可查看本地运行的知识库系统。
配置CI/CD
- Algolia配置:
- 设置
ALGOLIA_ADMIN_API_KEY
、ALGOLIA_APP_ID
仓库环境密钥,具体获取步骤请阅读 使用 Docusaurus 搭建优秀个人wiki。
- 设置
- 配置完成后,系统将按照
build.yml
和algolia.yml
的规则自动进行构建、部署和内容爬取推送。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】