Skip to content

Commit 918c3ec

Browse files
author
lizhogn
committed
配置 GitHub Pages 部署:添加 GitHub Actions 工作流和文档说明
1 parent c0ab0a5 commit 918c3ec

2 files changed

Lines changed: 99 additions & 85 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v4
29+
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: './docs'
34+
35+
- name: Deploy to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v4

docs/README.md

Lines changed: 62 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,82 @@
1-
# Python Web AI 开发教程
1+
# Python Web AI 开发教程文档
22

3-
> 📚 从零开始的 Python Web AI 开发完整教程
3+
## 📚 文档访问
44

5-
[![GitHub stars](https://img.shields.io/github/stars/lizhogn/python-webAI-tutorial.svg?style=social&label=Star)](https://github.com/lizhogn/python-webAI-tutorial)
6-
[![GitHub forks](https://img.shields.io/github/forks/lizhogn/python-webAI-tutorial.svg?style=social&label=Fork)](https://github.com/lizhogn/python-webAI-tutorial)
7-
[![GitHub issues](https://img.shields.io/github/issues/lizhogn/python-webAI-tutorial.svg)](https://github.com/lizhogn/python-webAI-tutorial/issues)
8-
[![GitHub license](https://img.shields.io/github/license/lizhogn/python-webAI-tutorial.svg)](https://github.com/lizhogn/python-webAI-tutorial/blob/main/LICENSE)
5+
### 在线访问
6+
- **GitHub Pages**: https://lizhogn.github.io/python-webAI-tutorial/
7+
- **本地预览**: 运行 `docsify serve docs` 后访问 http://localhost:3000
98

10-
## 🎯 项目简介
11-
12-
本项目是一个完整的 Python Web AI 开发教程,从基础概念到实战应用,帮助学习者掌握现代 Web 开发与 AI 集成的全栈技能。
13-
14-
### ✨ 特色亮点
15-
16-
* 🚀 **循序渐进** 从 Web 基础到 AI 集成的完整学习路径
17-
* 💻 **实战导向** 每个阶段都有完整的项目实践
18-
* 🔧 **技术栈全面** 涵盖 Flask、FastAPI、Vue.js、Docker 等主流技术
19-
* 🤖 **AI 集成** 从模型训练到 Web 部署的全流程
20-
* 📚 **开源免费** 完全开源,持续更新维护
21-
22-
## 📖 内容导航
23-
24-
| 章节 | 关键内容 | 状态 |
25-
|------|----------|------|
26-
| [前言](preface.md) | 项目介绍、学习建议、技术栈概览 ||
27-
| [第一章 Web 开发基础](chapter1/README.md) | HTTP 协议、Web 框架、前后端基础 ||
28-
| [第二章 后端开发进阶](chapter2/README.md) | FastAPI、数据库、API 设计 ||
29-
| [第三章 前端开发](chapter3/README.md) | Vue.js、组件化、状态管理 ||
30-
| [第四章 AI 模型集成](chapter4/README.md) | 模型服务化、异步处理、性能优化 ||
31-
| [第五章 部署与运维](chapter5/README.md) | Docker、Nginx、监控日志 ||
32-
| [第六章 实战项目](chapter6/README.md) | 完整项目开发、最佳实践 ||
33-
34-
## 🚀 快速开始
35-
36-
### 环境要求
37-
38-
- Python 3.8+
39-
- Node.js 16+
40-
- Docker (可选)
9+
### 文档结构
10+
```
11+
docs/
12+
├── index.html # 文档首页
13+
├── _coverpage.md # 封面页
14+
├── _sidebar.md # 侧边栏导航
15+
├── README.md # 本文件
16+
├── preface.md # 前言
17+
├── chapter1/ # 第一章:Web 开发基础
18+
├── chapter2/ # 第二章:后端开发进阶
19+
├── chapter3/ # 第三章:前端开发
20+
├── chapter4/ # 第四章:AI 模型集成
21+
├── chapter5/ # 第五章:部署与运维
22+
├── chapter6/ # 第六章:实战项目
23+
├── tools.md # 常用开发工具
24+
├── plugins.md # 生产力提升插件
25+
├── ai-tools.md # AI 相关工具
26+
├── open-source.md # 开源项目推荐
27+
├── others.md # 其他实用资源
28+
├── learning-progress.md # 学习进度
29+
├── roadmap.md # 学习路线图
30+
├── quick-start.md # 快速开始
31+
├── resources.md # 学习资源
32+
├── faq.md # 常见问题
33+
└── star-history.md # Star History
34+
```
4135

42-
### 快速体验
36+
## 🚀 本地开发
4337

38+
### 安装 docsify
4439
```bash
45-
# 克隆项目
46-
git clone https://github.com/lizhogn/python-webAI-tutorial.git
47-
cd python-webAI-tutorial
48-
49-
# 运行快速开始项目
50-
cd quick_start_project
51-
pip install -r requirements.txt
52-
python main.py
40+
npm install -g docsify-cli
5341
```
5442

55-
访问 http://localhost:8000 即可体验第一个 AI Web 应用!
56-
57-
## 💡 如何学习
58-
59-
本项目适合有一定 Python 基础的开发者,建议按以下顺序学习:
60-
61-
1. **基础知识** (第1-3章):掌握 Web 开发基础概念
62-
2. **进阶技能** (第4-5章):学习 AI 集成和部署技术
63-
3. **实战应用** (第6章):完成完整项目开发
64-
65-
每个章节都包含:
66-
- 📖 理论讲解
67-
- 💻 代码示例
68-
- 🎯 实践项目
69-
- 📝 学习总结
70-
71-
## 🤝 如何贡献
72-
73-
我们欢迎任何形式的贡献!
74-
75-
* 🐛 **报告 Bug** - 发现问题请提交 Issue
76-
* 💡 **功能建议** - 有好想法就告诉我们
77-
* 📝 **内容完善** - 帮助改进教程内容
78-
* 🔧 **代码优化** - 提交 Pull Request
43+
### 启动本地服务器
44+
```bash
45+
docsify serve docs
46+
```
7947

80-
## 📚 学习资源
48+
### 访问本地文档
49+
打开浏览器访问 http://localhost:3000
8150

82-
### 官方文档
83-
- [FastAPI 官方文档](https://fastapi.tiangolo.com/)
84-
- [Vue.js 官方文档](https://vuejs.org/)
85-
- [Docker 官方文档](https://docs.docker.com/)
51+
## 📖 文档特色
8652

87-
### 推荐阅读
88-
- [Python Web 开发最佳实践](https://realpython.com/)
89-
- [AI 模型部署指南](https://huggingface.co/docs)
53+
- **完整的教程体系**: 从基础到高级的完整学习路径
54+
- **丰富的代码示例**: 每个章节都包含详细的代码示例
55+
- **实用的工具推荐**: 推荐各种开发工具和学习资源
56+
- **中文友好**: 全中文内容,适合中文用户学习
57+
- **响应式设计**: 支持各种设备访问
9058

91-
## 🙏 致谢
59+
## 🔧 技术栈
9260

93-
感谢所有为本项目做出贡献的开发者们 ❤️
61+
- **文档框架**: docsify
62+
- **主题**: Vue 主题
63+
- **语法高亮**: Prism.js
64+
- **搜索功能**: docsify 内置搜索
65+
- **部署**: GitHub Pages
9466

95-
## 📄 开源协议
67+
## 📝 贡献指南
9668

97-
本作品采用 [MIT License](LICENSE) 进行许可。
69+
1. Fork 项目仓库
70+
2. 创建功能分支
71+
3. 修改文档内容
72+
4. 提交 Pull Request
73+
5. 等待审核合并
9874

99-
## Star History
75+
## 📞 联系方式
10076

101-
[![Star History Chart](https://api.star-history.com/svg?repos=lizhogn/python-webAI-tutorial&type=Date)](https://star-history.com/#lizhogn/python-webAI-tutorial&Date)
77+
- **GitHub**: https://github.com/lizhogn/python-webAI-tutorial
78+
- **Issues**: https://github.com/lizhogn/python-webAI-tutorial/issues
10279

10380
---
10481

105-
⭐ 如果这个项目对你有帮助,请给我们一个 Star!
82+
**开始你的学习之旅吧!** 🚀

0 commit comments

Comments
 (0)