Skip to content

Commit c1e33e2

Browse files
committed
docs: simplify README to match site content
Remove technical setup details, project structure, Skills tables, roadmap, and placeholder info. Keep only project intro, content categories, contribution guide, and contact info aligned with the live site.
1 parent cb07c7a commit c1e33e2

1 file changed

Lines changed: 21 additions & 238 deletions

File tree

README.md

Lines changed: 21 additions & 238 deletions
Original file line numberDiff line numberDiff line change
@@ -1,257 +1,40 @@
1-
# AI Agent 学术科研实践博客
1+
# Coding Agent for Academic Research
22

33
> LLM Agent(尤其是 Coding Agent)在学术研究中的应用经验分享
44
5-
## 📚 项目简介
5+
## 📖 项目简介
66

7-
本项目是一个基于 VitePress 构建的技术博客,专注于分享 AI Agent 在学术科研领域的实践经验和使用心得
7+
本项目是一个专注于分享 **Coding Agent 在学术科研中的应用经验**的技术博客
88

9-
**核心主题**:
10-
- 🤖 LLM Agent 基础概念与原理
11-
- 💻 Coding Agent 实践技巧
12-
- 🔬 学术科研场景应用案例
13-
- 🛠️ 工具对比与评测
14-
- 💡 经验总结与心得分享
9+
在从事学术研究的过程中,我逐渐认识到 Coding Agent 工具的强大潜力。无论是文献调研、数据分析、代码实现还是论文写作,Coding Agent 都能显著提升效率。本博客系统地记录和分享实践经验,帮助更多研究者高效利用这些工具。
1510

16-
## 🚀 快速开始
11+
**在线访问**: [https://hjnnjh.github.io/Agents-are-the-future-of-academic-research/](https://hjnnjh.github.io/Agents-are-the-future-of-academic-research/)
1712

18-
### 环境要求
13+
## 🎯 内容定位
1914

20-
- Node.js 18+
21-
- npm 9+ 或 pnpm 8+
22-
- Git 2.x
15+
- 🤖 **Agent 基础** — 深入理解 LLM Agent 的核心概念、架构原理和工作机制
16+
- 💻 **Coding Agent 实践** — Claude Code、OpenCode 等工具的深度使用技巧
17+
- 🔬 **学术科研案例** — Coding Agent 在文献调研、数据分析、论文写作等场景中的真实应用
18+
- 🛠️ **工具对比评测** — 主流 Coding Agent 工具的横向对比与选型建议
19+
- 💡 **经验心得分享** — 实践总结、踩坑记录、效率技巧
2320

24-
### 安装依赖
21+
## 🤝 参与贡献
2522

26-
```bash
27-
# 安装项目依赖
28-
npm install
29-
```
23+
如果你也在学术研究中使用 Coding Agent,欢迎:
3024

31-
### 本地开发
25+
- 📝 **分享经验**: 提交你的实践案例
26+
- 💬 **讨论交流**: 在 Issue 中提出问题
27+
-**Star 支持**: 如果觉得有用,请给个 Star
3228

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-
欢迎贡献内容和改进建议!
29+
## 📮 联系方式
23830

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
31+
- **GitHub**: [@hjnnjh](https://github.com/hjnnjh)
32+
- **Email**: jinnan_huang@stu.xjtu.edu.cn
24433

24534
## 📄 许可证
24635

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
36+
- **代码**: MIT License
37+
- **内容**: [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
25538

25639
---
25740

0 commit comments

Comments
 (0)