基于 Docusaurus 3 构建的现代化个人网站,集成了博客、文档、时刻分享和微信集成等功能。
- 📝 博客系统 - 支持 MDX 格式的文章发布
- 📚 文档系统 - 完整的主题使用文档
- ⏰ Moments 系统 - 时刻分享和动态展示
- 💬 微信集成 - 自动化 JSAPI Ticket 更新和分享功能
- 🔗 友链管理 - 友情链接展示和管理
- 📱 PWA 支持 - 渐进式 Web 应用体验
- 框架: Docusaurus 3.x
- 前端: React 18 + TypeScript
- 样式: CSS Modules + CSS Variables
- 构建: Webpack 5 + Babel
- 部署: GitHub Actions + GitHub Pages
- 集成: 微信 JS-SDK + Cloudflare Turnstile
- Node.js 18.x 或更高版本
- npm 或 yarn 包管理器
# 克隆项目
git clone https://github.com/RichardMiku/ricmoe-docusaurus.git
cd ricmoe-docusaurus
# 安装依赖
npm install
# 启动开发服务器
npm start开发服务器将在 http://localhost:3000 启动。
# 构建项目
npm run build
# 预览构建结果
npm run serve
# 部署到 GitHub Pages
npm run deployricmoe-docusaurus/
├── 📁 .github/workflows/ # GitHub Actions 工作流
├── 📁 blog/ # 博客文章
├── 📁 docs/ # 文档内容
├── 📁 data/ # 数据配置文件
├── 📁 i18n/ # 国际化语言包
├── 📁 src/ # 源代码
│ ├── components/ # React 组件
│ ├── pages/ # 页面组件
│ ├── css/ # 全局样式
│ └── theme/ # 主题定制
├── 📁 static/ # 静态资源
├── 📁 reports/ # 项目报告文件
├── 📄 docusaurus.config.ts # Docusaurus 配置
├── 📄 sidebars.ts # 侧边栏配置
└── 📄 package.json # 项目依赖
完整的使用文档请访问:/docs/ricmoe-theme/
- ⏰ Moments 系统 - 时刻分享功能详解
- 💬 微信集成 - 微信分享和 JSAPI 配置
- 🧩 组件系统 - 可复用组件使用指南
- 🛠️ 开发指南 - 架构、构建和部署
项目需要配置以下环境变量(用于 GitHub Actions):
WECHAT_APP_ID=your_wechat_app_id
WECHAT_APP_SECRET=your_wechat_app_secret- 在微信公众平台配置 JS 安全域名
- 在 GitHub 仓库设置中添加相应的 Secrets
- GitHub Actions 会自动更新 JSAPI Ticket
详细配置请参考:微信集成文档
- 特性配置:
data/Features.tsx - 友链配置:
data/Links.tsx - 时刻配置:
data/Moments.tsx
- 全局样式:
src/css/custom.css - 组件样式:
src/components/*/styles.module.css - 主题覆盖:
src/theme/
- 博客文章:
blog/目录 - 文档内容:
docs/目录 - 静态资源:
static/目录
项目支持中文(简体)和英文两种语言:
# 生成翻译文件
npm run write-translations
# 构建指定语言
npm run build -- --locale en-US网站支持 PWA 功能,包括:
- 离线访问
- 应用安装
- 推送通知
- 后台同步
- 内容安全策略 (CSP)
- Cloudflare Turnstile 人机验证
- HTTPS 强制重定向
- 安全响应头
- 代码分割 - 自动按路由分割
- 图片优化 - 支持 WebP 格式和懒加载
- 缓存策略 - 静态资源长期缓存
- CDN 加速 - Azure Static Website App
欢迎提交 Issue 和 Pull Request!
- Fork 项目
- 创建功能分支
- 提交代码变更
- 推送到分支
- 创建 Pull Request
本项目基于 MIT 许可证开源。详情请查看 LICENSE 文件。
- 在线预览: RICMOE
- 项目仓库: https://github.com/RichardMiku/ricmoe-docusaurus
- 问题反馈: GitHub Issues
- 功能建议: GitHub Discussions
- 作者: RichardMiku
- 邮箱: [mail@ric.moe]
- 主页: https://www.ric.moe
⭐ 如果这个项目对你有帮助,请给个 Star 支持一下!