README.md
skill_tree_oceanbase
初始化
pip install -r requirement.txt
目录结构说明
- 技能树
骨架文件
:- 位置:
data/tree.json
- 说明:该文件是执行
python main.py
生成的,请勿人工编辑
- 位置:
- 技能树
根节点
配置文件:- 位置:
data/config.json
- 说明:可编辑配置关键词等字段,其中
node_id
字段是生成的,请勿编辑
- 位置:
- 技能树
难度节点
:- 位置:
data/xxx
,例如:data/1.Oceanbase初阶
- 说明:
- 每个技能树有 3 个等级,目录前的序号是必要的,用来保持文件夹目录的顺序
- 每个目录下有一个
config.json
可配置关键词信息,其中node_id
字段是生成的,请勿编辑
- 位置:
- 技能树
章节点
:- 位置:
data/xxx/xxx
,例如:data/1.OceanBase初阶/1.快速入门
- 说明:
- 每个技能树的每个难度等级有 n 个章节,目录前的序号是必要的,用来保持文件夹目录的顺序
- 每个目录下有一个
config.json
可配置关键词信息,其中node_id
字段是生成的,请勿编辑
- 位置:
- 技能树
知识节点
:- 位置:
data/xxx/xxx/xxx
,例如:data/1.OceanBase初阶/1.快速入门/1.安装OBD
- 说明:
- 每个技能树的每章有
n
个知识节点,目录前的序号是必要的,用来保持文件夹目录的顺序 - 每个目录下有一个
config.json
- 其中
node_id
字段是生成的,请勿编辑 - 其中
keywords
可配置关键字字段 - 其中
children
可配置该知识节点
下的子树结构信息,参考后面描述 - 其中
export
可配置该知识节点
下的导出习题信息,参考后面描述
- 其中
- 每个技能树的每章有
- 位置:
知识节点
子树信息结构
例如 data/1.OceanBase初阶/7.查询数据/config.json
里配置对该知识节点子树信息结构:
// ...
"children": [
// TODO ...
],
}
知识节点
的导出习题编辑
例如 data/1.OceanBase初阶/7.查询数据/config.json
里配置对该知识节点导出的习题
{
// ...
"export": [
"hello.json"
]
}
每个文件名,指向对应的习题定义 json 。
知识节点
的导出习题选项配置编辑
首先,我们添加前文中 export 指定的习题配置,例如在 data/1.OceanBase初阶/7.查询数据
下增加一个hello.json
代码:
{
"type": "code_options",
"author": "刘鑫",
"source": "hello.md",
"exercise_id":"1190bb7834904da0b1f20915960714d5",
"notebook_enable": true
}
其中 type 字段目前都固定是 code_options
。exercise_id 可以不写,处理程序会自动填补这个数据。根据具体情况写好其它字段,注意这里 source 的文件名,我们指定了一个 markdwon 文件。现在我们新建一个 HelloWorld.md 并编辑为:
# Hello World
以下 `Hello World` 程序中,能够正确输出`hello`的是:
## 答案
```sql
select 'hello';
```
## 选项
### A
```sql
print 'hello';
```
### B
```sql
echo 'hello';
```
### C
```sql
log 'hello';
```
这是一个最基本的习题结构,它包含标题、答案、选项,注意这几个一级和二级标题必须填写正确,解释器会读取这几个标题。而选项的标题会被直接忽略掉,在最终生成的习题中不包含选项的三级标题,所以这个标题可以用来标注一些编辑信息,例如“此选项没有关闭文件连接”,“类型错误”等等。
技能树合成
在src
目录下执行 python main.py -a tree
会合成技能树文件,合成的技能树文件: data/tree.json
- 合成过程中,会自动检查每个目录下
config.json
里的node_id
是否存在,不存在则生成 - 合成过程中,会自动检查每个知识点目录下
config.json
里的export
里导出的习题配置,检查是否存在exercise_id
字段,如果不存在则生成