Skip to content

liberalchang/PythonModelBook

Repository files navigation

Python 知识体系文档

一个系统化整理 Python 知识体系的开源项目,旨在为 Python 学习者提供完整、清晰、易于导航的技术文档。

🌐 项目地址

🎯 项目特色

✨ 功能特点

  • 系统化结构: 按照学习路径组织内容,循序渐进
  • 搜索功能: 支持全文搜索,快速定位相关内容
  • 响应式设计: 适配桌面和移动设备
  • 目录导航: 页面右侧显示文档结构,支持快速跳转
  • 评论系统: 集成 Disqus 评论,支持交流讨论
  • 标签分类: 多维度标签系统,便于内容分类

📖 文档规范

  • 统一模板: 所有文档遵循统一的结构模板
  • 代码示例: 每个概念都包含可运行的代码示例
  • 实际应用: 提供真实场景的应用案例
  • 最佳实践: 包含编程最佳实践和注意事项
  • 交叉引用: 相关内容之间建立链接关系

🚀 快速开始

本地运行

  1. 克隆仓库
git clone https://github.com/liberalchang/PythonModelBook.git
cd PythonModelBook
  1. 安装依赖
## 安装 Ruby 和 Bundler
gem install bundler

## 安装项目依赖
bundle install

## 清理bundle缓存
bundle clean --force
  1. 启动服务
bundle exec jekyll serve
#指定端口
bundle exec jekyll serve --host 0.0.0.0 --port 4000 
  1. 访问网站 打开浏览器访问 http://localhost:4000

GitHub Pages 部署

  1. Fork 本仓库到您的 GitHub 账户
  2. 在仓库设置中启用 GitHub Pages
  3. 选择源分支(通常是 main 或 gh-pages)
  4. 访问 https://liberalchang.github.io/PythonModelBook

🤝 贡献指南

我们欢迎所有形式的贡献!请查看 贡献指南 了解详细信息。

贡献方式

  • 📝 内容贡献: 添加新文档、完善现有内容
  • 🐛 错误修正: 修复文档错误、代码问题
  • 💡 功能改进: 优化网站功能、用户体验
  • 🌍 国际化: 翻译文档、多语言支持

贡献者

感谢所有为本项目做出贡献的开发者!

📄 开源协议

本项目采用 MIT License 开源协议。

📞 联系我们

🔗 相关链接


⭐ 如果这个项目对您有帮助,请给我们一个 Star!

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published