Skip to content

Commit cee7551

Browse files
committed
chore: 移除旧配置文件并添加新结构
- 删除了旧的 _config.yml 文件,简化了配置。 - 新增 .1024 文件,定义了运行和依赖命令。 - 更新 .gitignore 文件,添加了 GitBook 生成的文件和临时文件的忽略规则。 - 新增 book.json 文件,定义了 Clacky AI 编程入门教程的基本信息和结构。 - 删除了 Gemfile 文件,移除了不再需要的依赖。 - 更新 index.md 文件,调整了链接格式以支持新的结构。 - 新增 package.json 文件,定义了项目的基本信息和脚本。 - 新增 SUMMARY.md 文件,提供了教程的目录结构。 - 新增 GitHub Actions 工作流配置文件,用于构建和部署 GitBook。
1 parent c63b57d commit cee7551

File tree

10 files changed

+154
-98
lines changed

10 files changed

+154
-98
lines changed

.1024

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
run_command: npm run serve
2+
dependency_command: npm install && npm run install
Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy to GitHub Pages
1+
name: Build and Deploy GitBook
22

33
on:
44
push:
@@ -22,23 +22,30 @@ jobs:
2222
- name: Checkout
2323
uses: actions/checkout@v4
2424

25-
- name: Setup Ruby
26-
uses: ruby/setup-ruby@v1
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
2727
with:
28-
ruby-version: "3.1"
29-
bundler-cache: true
28+
node-version: "18"
29+
cache: "npm"
30+
31+
- name: Install dependencies
32+
run: |
33+
npm install
34+
npm install -g gitbook-cli
35+
36+
- name: Install GitBook plugins
37+
run: gitbook install
38+
39+
- name: Build GitBook
40+
run: gitbook build
3041

3142
- name: Setup Pages
3243
uses: actions/configure-pages@v4
3344

34-
- name: Build with Jekyll
35-
run: |
36-
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
37-
env:
38-
JEKYLL_ENV: production
39-
4045
- name: Upload artifact
4146
uses: actions/upload-pages-artifact@v3
47+
with:
48+
path: ./_book
4249

4350
deploy:
4451
environment:

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# IDE files
22
.idea/
3+
4+
# GitBook 生成的文件
5+
_book/
6+
node_modules/
7+
*.epub
8+
*.mobi
9+
*.pdf
10+
11+
# 临时文件
12+
.tmp/
13+
.DS_Store

Gemfile

Lines changed: 0 additions & 23 deletions
This file was deleted.

SUMMARY.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Summary
2+
3+
* [首页](README.md)
4+
5+
## Tutorial - 教程
6+
7+
* [教程总览](tutorial/index.md)
8+
* [Clacky AI 编程入门教程](tutorial/Clacky-AI-编程入门教程.md)
9+
* [教程使用指南](tutorial/教程使用指南.md)
10+
* [第一部分 - Clacky AI 基础概念](tutorial/第一部分-Clacky-AI-基础概念.md)
11+
* [第二部分 - 快速入门指南](tutorial/第二部分-快速入门指南.md)
12+
* [第三部分 - 第一个项目实践](tutorial/第三部分-第一个项目实践.md)
13+
* [第四部分 - 进阶功能和最佳实践](tutorial/第四部分-进阶功能和最佳实践.md)
14+
* [实践练习和作业](tutorial/实践练习和作业.md)
15+
* [常见问题解答](tutorial/常见问题解答.md)
16+
17+
## 学员作品
18+
19+
* [作品展示](student-works/index.md)
20+
* [Dali 的作品](student-works/dali/index.md)
21+
* [提交作品指南](student-works/submit-prompt/index.md)
22+
23+
## 官方文档
24+
25+
* [文档总览](docs/README.md)
26+
* [介绍](docs/introduction.md)
27+
* [最佳实践](docs/best-practices.md)
28+
* [成功案例](docs/clackyai-success-cases.md)
29+
30+
### 入门指南
31+
32+
* [快速开始](docs/getting-started/README.md)
33+
* [从零开始构建](docs/getting-started/build-from-scratch.md)
34+
* [连接现有仓库](docs/getting-started/connect-existing-repo.md)
35+
36+
### Clacky Workspace
37+
38+
* [Workspace 概述](docs/clacky-workspace/README.md)
39+
* [环境配置](docs/clacky-workspace/environment.md)
40+
* [开发线程](docs/clacky-workspace/dev-thread.md)
41+
* [远程开发](docs/clacky-workspace/remote-dev.md)
42+
* [配置说明](docs/clacky-workspace/configure.md)
43+
44+
### Clacky AI
45+
46+
* [AI 功能概述](docs/clacky-ai/README.md)
47+
* [聊天代理](docs/clacky-ai/chat-agent.md)
48+
* [Git 代理](docs/clacky-ai/git-agent.md)
49+
* [任务规划代理](docs/clacky-ai/task-plan-agent.md)
50+
51+
### 集成
52+
53+
* [集成概述](docs/integrations/README.md)
54+
* [GitHub 集成](docs/integrations/github.md)
55+
* [GitLab 集成](docs/integrations/gitlab.md)

_config.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

book.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"title": "Clacky AI 编程入门教程",
3+
"description": "一个全面的 Clacky AI 编程入门教程,包含基础概念、快速入门、项目实践和进阶功能。",
4+
"author": "Clacky AI Workshop",
5+
"language": "zh-hans",
6+
"gitbook": "3.2.3",
7+
"root": ".",
8+
"structure": {
9+
"readme": "README.md",
10+
"summary": "SUMMARY.md"
11+
},
12+
"plugins": [
13+
"search-pro",
14+
"github",
15+
"edit-link",
16+
"prism",
17+
"-highlight",
18+
"copy-code-button",
19+
"expandable-chapters"
20+
],
21+
"pluginsConfig": {
22+
"github": {
23+
"url": "https://github.com/CodingGirlsClub/ai-clacky-workshop-tutorial"
24+
},
25+
"edit-link": {
26+
"base": "https://github.com/CodingGirlsClub/ai-clacky-workshop-tutorial/edit/main",
27+
"label": "编辑此页面"
28+
}
29+
}
30+
}

docs/clacky-workspace/configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
一个有效的 `.1024` 文件示例:
1616

1717
```yaml
18-
run_command: bin/dev
18+
run_command: npm run serve
1919
# dependency_command 会在你 fork 新线程前自动执行
20-
dependency_command: bundle install && yarn install
20+
dependency_command: npm install && npm run install
2121
```
2222
2323
一个无需编译的 python 项目:

index.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
---
2-
layout: default
3-
title: 首页
4-
nav_order: 1
5-
description: "Clacky AI 编程入门教程 - 专为零基础学习者设计的 AI 辅助编程教程"
6-
permalink: /
7-
---
8-
91
# Clacky AI 编程入门教程
102

113
## 🌟 项目简介
@@ -34,9 +26,9 @@ permalink: /
3426
3527
### 📚 选择你的学习路径
3628

37-
- **📖 [开始教程]({{ site.baseurl }}/tutorial/)** - 系统性学习完整教程
38-
- **🎨 [查看作品]({{ site.baseurl }}/student-works/)** - 浏览其他学员的优秀作品
39-
- **🚀 [提交作品]({{ site.baseurl }}/student-works/submit-prompt/)** - 完成学习后分享你的项目
29+
- **📖 [开始教程](tutorial/)** - 系统性学习完整教程
30+
- **🎨 [查看作品](student-works/)** - 浏览其他学员的优秀作品
31+
- **🚀 [提交作品](student-works/submit-prompt/)** - 完成学习后分享你的项目
4032

4133
---
4234

@@ -65,21 +57,21 @@ permalink: /
6557

6658
## 🎨 精选学员作品
6759

68-
### 🏔️ [大理站]({{ site.baseurl }}/student-works/dali/) - 首发站点
60+
### 🏔️ [大理站](student-works/dali/) - 首发站点
6961

7062
来自苍山洱海边的学员精彩作品展示
7163

7264
### 🌟 更多城市作品
7365

7466
- 🏙️ **北京站** | 🏢 **上海站** | 🌸 **成都站** - 即将开放
7567

76-
> 💡 **想要展示你的作品?** 使用我们的 [一键提交工具]({{ site.baseurl }}/student-works/submit-prompt/) 让 Clacky AI 帮你自动提交!
68+
> 💡 **想要展示你的作品?** 使用我们的 [一键提交工具](student-works/submit-prompt/) 让 Clacky AI 帮你自动提交!
7769
7870
---
7971

8072
## 🚀 开始你的编程之旅
8173

82-
**准备好了吗?** 让我们从 [教程目录]({{ site.baseurl }}/tutorial/) 开始,踏上 AI 辅助编程的学习之旅!
74+
**准备好了吗?** 让我们从 [教程目录](tutorial/) 开始,踏上 AI 辅助编程的学习之旅!
8375

8476
记住:每个专业的程序员都是从第一行代码开始的。有了 Clacky AI 的帮助,你的编程之路将更加顺畅和有趣!
8577

package.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"name": "ai-clacky-workshop-tutorial",
3+
"version": "1.0.0",
4+
"description": "Clacky AI 编程入门教程",
5+
"main": "index.js",
6+
"scripts": {
7+
"serve": "gitbook serve",
8+
"build": "gitbook build",
9+
"install": "gitbook install",
10+
"pdf": "gitbook pdf . ./output.pdf",
11+
"epub": "gitbook epub . ./output.epub",
12+
"mobi": "gitbook mobi . ./output.mobi"
13+
},
14+
"repository": {
15+
"type": "git",
16+
"url": "https://github.com/CodingGirlsClub/ai-clacky-workshop-tutorial.git"
17+
},
18+
"keywords": [
19+
"clacky-ai",
20+
"programming",
21+
"tutorial",
22+
"gitbook",
23+
"education"
24+
],
25+
"author": "Clacky AI Workshop",
26+
"license": "MIT",
27+
"devDependencies": {
28+
"gitbook-cli": "^2.3.2"
29+
}
30+
}

0 commit comments

Comments
 (0)