Skip to content

Commit 8944987

Browse files
authored
Merge pull request #20 from yiweinanzi/main
change to dev
2 parents 78f937b + d422de9 commit 8944987

191 files changed

Lines changed: 11131 additions & 10652 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 40 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,77 @@
11
# Vibe Research - AI 科研指南
22

3-
> 从 Idea 到论文发表的完整 AI 科研工作流指南
4-
5-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
6-
[![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)
3+
> 从 Idea 到论文投稿的完整 AI 科研工作流指南
74
85
## 简介
96

10-
本书是一份面向 AI 研究者的实用指南,使用 **Astro + Starlight** 构建,涵盖了从 idea 生成到论文发表的完整工作流程
7+
本项目已升级为 **Astro + Tailwind + MDX** 自定义站点,前端风格参考 `adongwanai.github.io`,并使用科研章节体系组织内容
118

129
## 在线阅读
1310

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

16-
你也可以通过环境变量覆盖站点地址(无需改代码)
13+
可通过环境变量覆盖
1714

1815
```bash
19-
GITHUB_USERNAME=<你的用户名> npm run build
16+
GITHUB_USERNAME=<你的用户名> GITHUB_REPO=ai-research-ebook npm run build
2017
```
2118

2219
## 本地开发
2320

2421
```bash
25-
# 安装依赖
2622
npm install
27-
28-
# 启动开发服务器
2923
npm run dev
30-
31-
# 构建生产版本
3224
npm run build
33-
34-
# 预览构建结果
3525
npm run preview
3626
```
3727

3828
## 部署前配置
3929

40-
`astro.config.mjs` 已支持环境变量配置
30+
`astro.config.mjs` 支持
4131

42-
- `GITHUB_USERNAME`:GitHub 用户名(默认 `yiweinanzi`
43-
- `GITHUB_REPO`:仓库名(默认 `ai-research-ebook`
44-
- `SITE_URL`:站点域名(默认 `https://<username>.github.io`
45-
- `BASE_PATH`:子路径(默认 `/<repo>`
46-
- `GITHUB_REPOSITORY_URL`:仓库完整 URL
32+
- `GITHUB_USERNAME`:默认 `yiweinanzi`
33+
- `GITHUB_REPO`:默认 `ai-research-ebook`
34+
- `SITE_URL`:默认 `https://<username>.github.io`
35+
- `BASE_PATH`:默认 `/<repo>`
4736

48-
示例:
37+
## 路由
4938

50-
```bash
51-
GITHUB_USERNAME=<你的用户名> GITHUB_REPO=ai-research-ebook npm run build
52-
```
39+
- `/`:复刻风格首页
40+
- `/docs/...`:章节文档页(含左侧导航、TOC、上下篇)
41+
- `/skills`:技能工具页
5342

54-
## 内容大纲
43+
示例:
5544

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

6349
## 技术栈
6450

65-
- [Astro](https://astro.build) - 现代静态站点生成器
66-
- [Starlight](https://starlight.astro.build) - Astro 的文档主题
67-
- [GitHub Pages](https://pages.github.com) - 免费静态托管
68-
- [GitHub Actions](https://github.com/features/actions) - 自动部署
69-
70-
## 项目结构
71-
72-
```
73-
.
74-
├── public/
75-
│ └── logo.svg
76-
├── src/
77-
│ ├── content/
78-
│ │ └── docs/ # Markdown 内容文件
79-
│ ├── styles/
80-
│ │ └── custom.css # 自定义样式
81-
│ └── content.config.ts
82-
├── astro.config.mjs
83-
└── package.json
51+
- [Astro](https://astro.build)
52+
- [Tailwind CSS](https://tailwindcss.com)
53+
- [MDX](https://docs.astro.build/en/guides/integrations-guide/mdx/)
54+
- GitHub Pages + GitHub Actions
55+
56+
## 内容结构
57+
58+
```text
59+
src/
60+
content/
61+
docs/
62+
intro/
63+
idea/
64+
code/
65+
figures/
66+
writing/
67+
review/
68+
tools/
69+
library/
70+
layouts/
71+
components/
72+
pages/
8473
```
8574

8675
## 许可证
8776

8877
MIT License
89-
90-
---
91-
92-
最后更新: 2026年2月9日
Lines changed: 9 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,19 @@
11
// @ts-check
22
import { defineConfig } from 'astro/config';
3-
import starlight from '@astrojs/starlight';
3+
import tailwind from '@astrojs/tailwind';
4+
import mdx from '@astrojs/mdx';
45

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

14-
// https://astro.build/config
1511
export default defineConfig({
16-
site: siteUrl,
17-
base: basePath,
18-
integrations: [
19-
starlight({
20-
title: 'Vibe Research - AI 科研指南',
21-
description: 'AI研究电子书 - 从idea到论文的完整指南',
22-
head: [
23-
{
24-
tag: 'script',
25-
content:
26-
"(() => { try { const key = 'starlight-theme'; localStorage.setItem(key, 'light'); document.documentElement.dataset.theme = 'light'; } catch { document.documentElement.dataset.theme = 'light'; } })();",
27-
},
28-
{
29-
tag: 'script',
30-
attrs: {
31-
type: 'module',
32-
src: `${normalizedBasePath}/scripts/mermaid-init.js?v=${mermaidScriptVersion}`,
33-
},
34-
},
35-
],
36-
logo: {
37-
src: './src/assets/logo.svg',
38-
alt: 'Vibe Research',
39-
},
40-
social: [{ icon: 'github', label: 'GitHub', href: repositoryUrl }],
41-
sidebar: [
42-
{
43-
label: '首页',
44-
items: [{ label: '关于本书', slug: 'index' }],
45-
},
46-
{
47-
label: '1. Idea 生成',
48-
items: [
49-
{ label: '1.1 调研方法', slug: 'idea/research' },
50-
{ label: '1.2 调研项目', slug: 'idea/projects' },
51-
],
52-
},
53-
{
54-
label: '2. 代码实现',
55-
items: [
56-
{ label: '2.1 Claude Code', slug: 'code/claude' },
57-
{ label: '2.2 GPT-5.2 系列', slug: 'code/gpt' },
58-
{ label: '2.3 多Agent框架', slug: 'code/agents' },
59-
],
60-
},
61-
{
62-
label: '3. 论文图表',
63-
items: [
64-
{ label: '3.1 自动化绘图工具', slug: 'figures/tools' },
65-
{ label: '3.2 专业绘图对比', slug: 'figures/comparison' },
66-
{ label: '3.3 图表设计规范', slug: 'figures/design' },
67-
],
68-
},
69-
{
70-
label: '4. 论文写作',
71-
items: [
72-
{ label: '4.1 写作方法', slug: 'writing/methods' },
73-
{ label: '4.2 Prism 编辑器', slug: 'writing/prism' },
74-
{ label: '4.3 多模型协作', slug: 'writing/collaboration' },
75-
],
76-
},
77-
{
78-
label: '5. 审稿与Rebuttal',
79-
items: [
80-
{ label: '5.1 结构化审稿', slug: 'review/structured' },
81-
{ label: '5.2 会议审稿模板', slug: 'review/templates' },
82-
{ label: '5.3 Rebuttal策略', slug: 'writing/rebuttal' },
83-
],
84-
},
85-
{
86-
label: '6. 工具生态',
87-
items: [
88-
{ label: '6.1 工具总览', slug: 'tools/overview' },
89-
{ label: '6.2 完整工作流', slug: 'tools/workflow' },
90-
],
91-
},
92-
{
93-
label: '7. 资料库',
94-
items: [
95-
{ label: '7.1 科研圣经', slug: 'library/root-assets' },
96-
],
97-
},
98-
],
99-
customCss: ['./src/styles/custom.css'],
100-
}),
101-
],
102-
output: 'static',
103-
build: {
104-
format: 'directory',
105-
},
12+
site: siteUrl,
13+
base: basePath,
14+
integrations: [tailwind(), mdx()],
15+
output: 'static',
16+
build: {
17+
format: 'directory',
18+
},
10619
});

0 commit comments

Comments
 (0)