Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
workflow_dispatch:

permissions:
contents: read
contents: write
pages: write
id-token: write

Expand All @@ -19,6 +19,42 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: external/ai-research-ebook/package-lock.json

- name: Install dependencies for research ebook
working-directory: external/ai-research-ebook
run: npm ci

- name: Build research ebook with custom base path
working-directory: external/ai-research-ebook
env:
SITE_URL: https://adongwanai.github.io
BASE_PATH: /AgentGuide/research
GITHUB_USERNAME: adongwanai
GITHUB_REPO: AgentGuide
GITHUB_REPOSITORY_URL: https://github.com/adongwanai/AgentGuide
run: npm run build

- name: Copy to research directory
run: |
rm -rf research
mkdir -p research
cp -r external/ai-research-ebook/dist/* research/

- name: Commit research directory if changed
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add research/
git diff --quiet && git diff --staged --quiet || git commit -m "Auto-update research ebook"
git push || echo "No changes to push"

- uses: actions/upload-pages-artifact@v3
with:
path: .
Expand All @@ -31,4 +67,4 @@ jobs:
needs: build
steps:
- id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ LICENSE
CHANGELOG.md
READY_TO_LAUNCH.md

# ai-research-ebook 构建产物和依赖
external/ai-research-ebook/dist/
external/ai-research-ebook/node_modules/
external/ai-research-ebook/.astro/

4 changes: 4 additions & 0 deletions external/ai-research-ebook/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions external/ai-research-ebook/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
92 changes: 92 additions & 0 deletions external/ai-research-ebook/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Vibe Research - AI 科研指南

> 从 Idea 到论文发表的完整 AI 科研工作流指南

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
[![Deploy to GitHub Pages](https://github.com/yiweinanzi/ai-research-ebook/workflows/Deploy%20to%20GitHub%20Pages/badge.svg)](https://github.com/yiweinanzi/ai-research-ebook/actions)

## 简介

本书是一份面向 AI 研究者的实用指南,使用 **Astro + Starlight** 构建,涵盖了从 idea 生成到论文发表的完整工作流程。

## 在线阅读

📖 **默认地址:`https://yiweinanzi.github.io/ai-research-ebook`**

你也可以通过环境变量覆盖站点地址(无需改代码):

```bash
GITHUB_USERNAME=<你的用户名> npm run build
```

## 本地开发

```bash
# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建生产版本
npm run build

# 预览构建结果
npm run preview
```

## 部署前配置

`astro.config.mjs` 已支持环境变量配置:

- `GITHUB_USERNAME`:GitHub 用户名(默认 `yiweinanzi`)
- `GITHUB_REPO`:仓库名(默认 `ai-research-ebook`)
- `SITE_URL`:站点域名(默认 `https://<username>.github.io`)
- `BASE_PATH`:子路径(默认 `/<repo>`)
- `GITHUB_REPOSITORY_URL`:仓库完整 URL

示例:

```bash
GITHUB_USERNAME=<你的用户名> GITHUB_REPO=ai-research-ebook npm run build
```

## 内容大纲

- **1. Idea 生成**: 系统化的文献调研方法,使用多模型交叉验证
- **2. 代码实现**: Claude Code、GPT-5.2、多Agent框架的最佳实践
- **3. 论文图表**: 自动化绘图工具推荐,专业图表设计规范
- **4. 论文写作**: 论证链构建方法,多模型协作写作
- **5. 审稿与 Rebuttal**: 结构化审稿流水线,Rebuttal 写作策略
- **6. 工具生态**: Elicit、Zotero-MCP 等最新工具,构建完整科研工具链

## 技术栈

- [Astro](https://astro.build) - 现代静态站点生成器
- [Starlight](https://starlight.astro.build) - Astro 的文档主题
- [GitHub Pages](https://pages.github.com) - 免费静态托管
- [GitHub Actions](https://github.com/features/actions) - 自动部署

## 项目结构

```
.
├── public/
│ └── logo.svg
├── src/
│ ├── content/
│ │ └── docs/ # Markdown 内容文件
│ ├── styles/
│ │ └── custom.css # 自定义样式
│ └── content.config.ts
├── astro.config.mjs
└── package.json
```

## 许可证

MIT License

---

最后更新: 2026年2月9日
106 changes: 106 additions & 0 deletions external/ai-research-ebook/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

const repoName = process.env.GITHUB_REPO ?? 'ai-research-ebook';
const githubUsername = process.env.GITHUB_USERNAME ?? 'yiweinanzi';
const siteUrl = process.env.SITE_URL ?? `https://${githubUsername}.github.io`;
const basePath = process.env.BASE_PATH ?? `/${repoName}`;
const normalizedBasePath = basePath === '/' ? '' : basePath;
const mermaidScriptVersion = process.env.MERMAID_SCRIPT_VERSION ?? '20260209e';
const repositoryUrl =
process.env.GITHUB_REPOSITORY_URL ?? `https://github.com/${githubUsername}/${repoName}`;

// https://astro.build/config
export default defineConfig({
site: siteUrl,
base: basePath,
integrations: [
starlight({
title: 'Vibe Research - AI 科研指南',
description: 'AI研究电子书 - 从idea到论文的完整指南',
head: [
{
tag: 'script',
content:
"(() => { try { const key = 'starlight-theme'; localStorage.setItem(key, 'light'); document.documentElement.dataset.theme = 'light'; } catch { document.documentElement.dataset.theme = 'light'; } })();",
},
{
tag: 'script',
attrs: {
type: 'module',
src: `${normalizedBasePath}/scripts/mermaid-init.js?v=${mermaidScriptVersion}`,
},
},
],
logo: {
src: './src/assets/logo.svg',
alt: 'Vibe Research',
},
social: [{ icon: 'github', label: 'GitHub', href: repositoryUrl }],
sidebar: [
{
label: '首页',
items: [{ label: '关于本书', slug: 'index' }],
},
{
label: '1. Idea 生成',
items: [
{ label: '1.1 调研方法', slug: 'idea/research' },
{ label: '1.2 调研项目', slug: 'idea/projects' },
],
},
{
label: '2. 代码实现',
items: [
{ label: '2.1 Claude Code', slug: 'code/claude' },
{ label: '2.2 GPT-5.2 系列', slug: 'code/gpt' },
{ label: '2.3 多Agent框架', slug: 'code/agents' },
],
},
{
label: '3. 论文图表',
items: [
{ label: '3.1 自动化绘图工具', slug: 'figures/tools' },
{ label: '3.2 专业绘图对比', slug: 'figures/comparison' },
{ label: '3.3 图表设计规范', slug: 'figures/design' },
],
},
{
label: '4. 论文写作',
items: [
{ label: '4.1 写作方法', slug: 'writing/methods' },
{ label: '4.2 Prism 编辑器', slug: 'writing/prism' },
{ label: '4.3 多模型协作', slug: 'writing/collaboration' },
],
},
{
label: '5. 审稿与Rebuttal',
items: [
{ label: '5.1 结构化审稿', slug: 'review/structured' },
{ label: '5.2 会议审稿模板', slug: 'review/templates' },
{ label: '5.3 Rebuttal策略', slug: 'writing/rebuttal' },
],
},
{
label: '6. 工具生态',
items: [
{ label: '6.1 工具总览', slug: 'tools/overview' },
{ label: '6.2 完整工作流', slug: 'tools/workflow' },
],
},
{
label: '7. 资料库',
items: [
{ label: '7.1 科研圣经', slug: 'library/root-assets' },
],
},
],
customCss: ['./src/styles/custom.css'],
}),
],
output: 'static',
build: {
format: 'directory',
},
});
Loading