Skip to content

Commit 13b5cd3

Browse files
committed
Initial commit: Coding Agent for Academic Research blog
VitePress-based blog with GitHub Pages deployment via Actions.
0 parents  commit 13b5cd3

12 files changed

Lines changed: 5539 additions & 0 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
# 只允许一个并发部署,跳过正在运行的队列
14+
concurrency:
15+
group: pages
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0 # 获取完整历史,用于 lastUpdated
26+
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 20
31+
cache: npm
32+
33+
- name: Install dependencies
34+
run: npm ci
35+
36+
- name: Build with VitePress
37+
run: npm run build
38+
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: docs/.vitepress/dist
43+
44+
deploy:
45+
environment:
46+
name: github-pages
47+
url: ${{ steps.deployment.outputs.page_url }}
48+
needs: build
49+
runs-on: ubuntu-latest
50+
steps:
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# VitePress build output & cache
5+
docs/.vitepress/dist/
6+
docs/.vitepress/cache/
7+
.temp/
8+
9+
# Claude Code
10+
.claude/
11+
12+
# Spec workflow
13+
.spec-workflow/
14+
15+
# Backup
16+
.backup/
17+
18+
# Source images (already copied to docs/public/img/)
19+
img/
20+
21+
# Project docs (not part of the site)
22+
PROJECT-COMPLETE-GUIDE.md
23+
24+
# Environment variables
25+
.env
26+
.env.local
27+
.env.*.local
28+
29+
# Logs
30+
*.log
31+
npm-debug.log*
32+
yarn-debug.log*
33+
pnpm-debug.log*
34+
35+
# Editor
36+
.vscode/
37+
.idea/
38+
39+
# OS
40+
.DS_Store
41+
Thumbs.db
42+
43+
# Temporary files
44+
*.tmp
45+
*.bak
46+
*.swp
47+
*~

README.md

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,258 @@
1+
# AI Agent 学术科研实践博客
2+
3+
> LLM Agent(尤其是 Coding Agent)在学术研究中的应用经验分享
4+
5+
## 📚 项目简介
6+
7+
本项目是一个基于 VitePress 构建的技术博客,专注于分享 AI Agent 在学术科研领域的实践经验和使用心得。
8+
9+
**核心主题**:
10+
- 🤖 LLM Agent 基础概念与原理
11+
- 💻 Coding Agent 实践技巧
12+
- 🔬 学术科研场景应用案例
13+
- 🛠️ 工具对比与评测
14+
- 💡 经验总结与心得分享
15+
16+
## 🚀 快速开始
17+
18+
### 环境要求
19+
20+
- Node.js 18+
21+
- npm 9+ 或 pnpm 8+
22+
- Git 2.x
23+
24+
### 安装依赖
25+
26+
```bash
27+
# 安装项目依赖
28+
npm install
29+
```
30+
31+
### 本地开发
32+
33+
```bash
34+
# 启动开发服务器
35+
npm run dev
36+
37+
# 访问 http://localhost:5173
38+
```
39+
40+
### 构建部署
41+
42+
```bash
43+
# 构建生产版本
44+
npm run build
45+
46+
# 预览构建结果
47+
npm run preview
48+
```
49+
50+
## 📁 项目结构
51+
52+
```
53+
agents-academic-blog/
54+
├── docs/ # 博客源文件
55+
│ ├── .vitepress/ # VitePress 配置
56+
│ │ ├── config.ts # 主配置文件
57+
│ │ └── theme/ # 自定义主题
58+
│ ├── posts/ # 博客文章
59+
│ │ └── 2025/ # 按年份组织
60+
│ ├── categories/ # 分类页面
61+
│ ├── about/ # 关于页面
62+
│ └── index.md # 首页
63+
├── scripts/ # 工具脚本
64+
│ └── new-post.js # 创建新文章
65+
├── .claude/ # Claude Code Skills
66+
│ └── skills/ # 自定义技能
67+
├── package.json
68+
└── README.md
69+
```
70+
71+
## ✍️ 写作指南
72+
73+
### 创建新文章
74+
75+
使用 npm 脚本快速创建:
76+
77+
```bash
78+
npm run new-post
79+
```
80+
81+
或手动创建文件 `docs/posts/YYYY/YYYY-MM-DD-title.md`,使用以下模板:
82+
83+
```markdown
84+
---
85+
title: "文章标题"
86+
date: 2025-01-04
87+
author: "作者名"
88+
categories:
89+
- coding-agent
90+
tags:
91+
- claude-code
92+
- tutorial
93+
difficulty: intermediate
94+
summary: "文章摘要"
95+
featured: false
96+
---
97+
98+
# 文章标题
99+
100+
## 摘要
101+
102+
<!-- 内容 -->
103+
```
104+
105+
### 分类体系
106+
107+
- **agent-basics**: Agent 基础概念
108+
- **coding-agent**: Coding Agent 实践
109+
- **research-cases**: 学术科研案例
110+
- **tools-comparison**: 工具对比
111+
- **insights**: 经验心得
112+
113+
### Markdown 增强功能
114+
115+
#### 数学公式
116+
117+
```markdown
118+
行内公式:$E = mc^2$
119+
120+
块级公式:
121+
$$
122+
\frac{\partial L}{\partial w} = \sum_{i=1}^{N} (y_i - \hat{y}_i) x_i
123+
$$
124+
```
125+
126+
#### 代码高亮
127+
128+
````markdown
129+
```python {1,3-5}
130+
def quick_sort(arr):
131+
if len(arr) <= 1:
132+
return arr
133+
# 核心逻辑
134+
```
135+
````
136+
137+
#### Mermaid 图表
138+
139+
````markdown
140+
```mermaid
141+
graph TD
142+
A[开始] --> B[处理]
143+
B --> C[结束]
144+
```
145+
````
146+
147+
## 🛠️ Claude Code Skills
148+
149+
本项目集成了 **12 个专业 Skills** 全面提升写作效率:
150+
151+
### 📝 写作与内容创作 (4 个)
152+
153+
| Skill | 功能 | 优先级 |
154+
|-------|------|--------|
155+
| [markdown-tools](./.claude/skills/markdown-tools/SKILL.md) | Word/PDF/PPT → Markdown 转换 | ⭐⭐⭐⭐⭐ |
156+
| [content-research-writer](./.claude/skills/content-research-writer/SKILL.md) | AI 驱动的研究写作 | ⭐⭐⭐⭐⭐ |
157+
| [prompt-optimizer](./.claude/skills/prompt-optimizer/SKILL.md) | 优化 AI 提示词 | ⭐⭐⭐⭐ |
158+
| [beautiful-prose](./.claude/skills/beautiful-prose/SKILL.md) | 语言风格润色 | ⭐⭐⭐ |
159+
160+
### 🛠️ 技术工具 (3 个)
161+
162+
| Skill | 功能 | 优先级 |
163+
|-------|------|--------|
164+
| [mermaid-tools](./.claude/skills/mermaid-tools/SKILL.md) | 快速生成流程图/架构图 | ⭐⭐⭐⭐⭐ |
165+
| [changelog-generator](./.claude/skills/changelog-generator/SKILL.md) | Git 变更日志生成 | ⭐⭐⭐ |
166+
| [docs-cleaner](./.claude/skills/docs-cleaner/SKILL.md) | 文档整理规范化 | ⭐⭐⭐ |
167+
168+
### 🎨 设计展示 (2 个)
169+
170+
| Skill | 功能 | 优先级 |
171+
|-------|------|--------|
172+
| [ui-designer](./.claude/skills/ui-designer/SKILL.md) | 设计系统提取 | ⭐⭐⭐⭐ |
173+
| [cli-demo-generator](./.claude/skills/cli-demo-generator/SKILL.md) | CLI 演示动画 | ⭐⭐⭐ |
174+
175+
### 📄 文档处理 + ✅ 质量保证 (3 个)
176+
177+
| Skill | 功能 | 优先级 |
178+
|-------|------|--------|
179+
| [pdf-creator](./.claude/skills/pdf-creator/SKILL.md) | 生成专业 PDF | ⭐⭐⭐⭐ |
180+
| [fact-checker](./.claude/skills/fact-checker/SKILL.md) | 事实验证 | ⭐⭐⭐⭐ |
181+
| [skill-reviewer](./.claude/skills/skill-reviewer/SKILL.md) | Skills 质量审查 | ⭐⭐⭐ |
182+
183+
📚 **详细文档**:
184+
- [Skills 总览](./.claude/skills/README.md) - 所有 skills 完整文档
185+
- [使用指南](./docs/SKILLS-GUIDE.md) - 场景化工作流和最佳实践
186+
- [原设计文档](./docs/claude-code-skills-design.md) - 项目初始规划
187+
188+
## 📖 技术文档
189+
190+
### 核心文档
191+
192+
- **[完整项目指南](PROJECT-COMPLETE-GUIDE.md)** ⭐ - 一站式完整指南,整合所有关键信息
193+
- [技术架构设计文档](docs/tech-architecture.md) - 技术选型和架构设计
194+
- [Claude Code Skills 设计文档](docs/claude-code-skills-design.md) - 原始 Skills 设计
195+
- [项目初始化指南](docs/initialization-guide.md) - 详细搭建步骤
196+
197+
### Skills 相关
198+
199+
- [Skills 使用指南](docs/SKILLS-GUIDE.md) - 场景化使用教程
200+
- [Skills 安装总结](docs/SKILLS-INSTALLATION-SUMMARY.md) - 安装概览和快速开始
201+
202+
## 🚀 部署
203+
204+
本项目使用 GitHub Actions 自动部署到 GitHub Pages。
205+
206+
### 部署步骤
207+
208+
1. **推送到 GitHub**:
209+
```bash
210+
git add .
211+
git commit -m "feat: add new post"
212+
git push origin main
213+
```
214+
215+
2. **自动部署**: GitHub Actions 会自动构建并部署到 `gh-pages` 分支
216+
217+
3. **访问网站**: `https://yourusername.github.io/agents-academic-blog/`
218+
219+
### 配置 GitHub Pages
220+
221+
1. 进入仓库 Settings → Pages
222+
2. Source 选择 "GitHub Actions"
223+
3. 等待部署完成
224+
225+
## 📊 项目路线图
226+
227+
- [x] 技术架构设计
228+
- [x] Claude Code Skills 设计
229+
- [ ] 初始化 VitePress 项目
230+
- [ ] 创建首个示例文章
231+
- [ ] 实现 Skills 脚本
232+
- [ ] 配置 GitHub Actions
233+
- [ ] 发布第一版
234+
235+
## 🤝 贡献指南
236+
237+
欢迎贡献内容和改进建议!
238+
239+
1. Fork 本仓库
240+
2. 创建特性分支 (`git checkout -b feature/amazing-post`)
241+
3. 提交更改 (`git commit -m 'feat: add amazing post'`)
242+
4. 推送到分支 (`git push origin feature/amazing-post`)
243+
5. 创建 Pull Request
244+
245+
## 📄 许可证
246+
247+
本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件
248+
249+
内容采用 [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) 许可
250+
251+
## 📮 联系方式
252+
253+
- GitHub: [@yourusername](https://github.com/yourusername)
254+
- Email: your.email@example.com
255+
256+
---
257+
258+
**Built with** ❤️ **using VitePress and Claude Code**

0 commit comments

Comments
 (0)