导航
欢迎来到 jimmysong.io Hugo 网站的完整文档系统!
🚀 快速开始
新用户入门
- 快速开始指南 - 5 分钟快速上手
- 内容创建指南 - 创建和管理网站内容
- Shortcode 使用 - 内置功能组件使用
开发者入门
- 环境设置 - 完整的开发环境配置
- Cloudflare Tunnel - 开发环境隧道配置
- 架构概览 - 项目架构和技术栈
- 构建流程 - 构建和部署流程
✨ 核心功能
🎯 内容管理系统
- 多语言支持 - 中英文内容管理
- 多内容类型 - 博客、图书、播客、通知等
- 智能分类 - 自动标签和分类系统
- SEO 优化 - 内置 SEO 最佳实践
📊 内容分析系统
- 自动化分析 - 内容统计和趋势分析
- 可视化图表 - 丰富的图表展示
- 双语分析 - 中英文内容对应关系
- 性能监控 - 内容质量和性能指标
🖼️ 图片优化系统
- 自动优化 - WebP 格式转换和压缩
- CDN 上传 - 自动上传到 Cloudflare R2
- 响应式图片 - 多尺寸和格式支持
- 懒加载 - 性能优化的图片加载
📚 PDF 导出系统
- 图书导出 - 完整的图书 PDF 生成
- 多格式支持 - 支持复杂布局和图表
- 中文支持 - 完整的中文字体和排版
- 批量处理 - 自动化批量导出
🛠️ 工具和脚本
自动化工具
- 内容分析 -
scripts/generate-analysis-data.js
- 图片处理 -
scripts/add-image-dimensions.js
- Mermaid 转换 -
scripts/transform-mermaid.js
- 文档维护 -
scripts/docs-maintenance.js
开发工具
- PDF 导出器 -
tools/pdf-book-exporter/
- 图片转换器 -
tools/convert-images-to-webp/
- AI 聊天机器人 -
tools/rag-worker/
- 微信文章导出器 -
tools/wechat-markdown-exporter/
📁 项目结构
website/
├── content/ # 内容文件
│ ├── zh/ # 中文内容
│ │ ├── blog/ # 博客文章
│ │ ├── book/ # 图书内容
│ │ ├── podcast/ # 播客节目
│ │ ├── ai/ # AI 资源
│ │ └── ... # 其他内容类型
│ └── en/ # 英文内容
├── layouts/ # Hugo 模板
│ ├── _default/ # 默认模板
│ ├── partials/ # 部分模板
│ ├── shortcodes/ # 自定义 Shortcode
│ └── ... # 其他模板
├── assets/ # 源文件
│ ├── scss/ # 样式文件
│ ├── js/ # JavaScript 文件
│ └── plugins/ # 第三方插件
├── scripts/ # 构建脚本
├── tools/ # 开发工具
├── docs/ # 文档系统
└── config/ # 配置文件
🔧 技术栈
核心框架
- Hugo Extended - 静态网站生成器
- Node.js - 构建工具和脚本
- Python - 内容处理和自动化
- SCSS - 样式预处理
前端技术
- Bootstrap 5 - UI 框架
- Chart.js - 数据可视化
- Mermaid - 图表生成
- Font Awesome - 图标库
部署和优化
- Cloudflare Pages - 静态托管
- Cloudflare R2 - 对象存储
- PostCSS - CSS 后处理
- WebP/AVIF - 现代图片格式
📈 性能特性
构建优化
- 增量构建 - 智能文件变更检测
- 并行处理 - 多核 CPU 利用
- 资源压缩 - CSS/JS/图片优化
- 缓存策略 - 智能缓存管理
运行时优化
- 懒加载 - 图片和组件懒加载
- 预加载 - 关键资源预加载
- 代码分割 - JavaScript 模块化
- CDN 分发 - 全球内容分发
🚀 快速启动
1. 克隆项目
git clone https://github.com/rootsongjc/website.git
cd website
2. 安装依赖
npm install
python3 -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
3. 启动开发服务器
# 基础开发服务器
hugo server
# 增强开发环境
make server
# Cloudflare Tunnel 开发环境(推荐)
make dev
# 生产构建
npm run build
4. 访问网站
- 本地开发: http://localhost:1313
- 网络访问: http://[your-ip]:1313
- 隧道访问: https://dev.jimmysong.io(需要配置 Cloudflare Tunnel)
5. Cloudflare Tunnel 管理
# 查看隧道状态
make tunnel ACTION=status
# 查看隧道日志
make tunnel ACTION=logs
# 停止隧道
make tunnel ACTION=stop
# 测试本地服务
make tunnel ACTION=test
📚 文档导航
用户指南
开发者指南
功能特性
工具文档
🤝 参与贡献
我们欢迎所有形式的贡献!
贡献方式
- 报告问题 - 提交 Issue 报告 bug
- 功能建议 - 提出新功能想法
- 代码贡献 - 提交 Pull Request
- 文档改进 - 完善和更新文档
开始贡献
- Fork 项目仓库
- 创建功能分支
- 提交你的更改
- 创建 Pull Request
详细指南请参考 贡献指南。
📞 获取帮助
支持渠道
- GitHub Issues - 技术问题和功能请求
- GitHub Discussions - 一般讨论和问题
- 文档系统 - 完整的使用指南
- 代码示例 - 实际使用案例
常见问题
🔄 更新日志
查看最新的更新和变更: