diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..cb7465f8291685dea5dab6d68ce5f188529e873a --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.vscode +.idea +.DS_Store +__pycache__ +*.pyc +*.zip +*.out +bin/ +debug/ +release/ \ No newline at end of file diff --git a/README.md b/README.md index 73af4f24ed400886332b58f2d50079502ab5785c..57f7f8b4ad6c875603a73cab857bcb2af1206eb0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,131 @@ # skill_tree_mysql -MySQL 技能树 \ No newline at end of file +`MySQL技能树`是[技能森林](https://gitcode.net/csdn/skill_tree)的一部分。 + +## 编辑环境初始化 + +``` +pip install -r requirements.txt +``` + +## 目录结构说明 +技能树编辑仓库的 data 目录是主要的编辑目录,目录的结构是固定的 + +* 技能树`骨架文件`: + * 位置:`data/tree.json` + * 说明:该文件是执行 `python main.py` 生成的,请勿人工编辑 +* 技能树`根节点`配置文件: + * 位置:`data/config.json` + * 说明:可编辑配置关键词等字段,其中 `node_id` 字段是生成的,请勿编辑 +* 技能树`难度节点`: + * 位置:`data/xxx`,例如: `data/1.MySQL初阶` + * 说明: + * 每个技能树有 3 个等级,目录前的序号是必要的,用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑 +* 技能树`章节点`: + * 位置:`data/xxx/xxx`,例如:`data/1.MySQL初阶/1.MySQL简介` + * 说明: + * 每个技能树的每个难度等级有 n 个章节,目录前的序号是必要的,用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑 +* 技能树`知识节点`: + * 位置:`data/xxx/xxx`,例如:`data/1.MySQL初阶/1.MySQL简介` + * 说明: + * 每个技能树的每章有 n 个知识节点,目录前的序号是必要的,用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` + * 其中 `node_id` 字段是生成的,请勿编辑 + * 其中 `keywords` 可配置关键字字段 + * 其中 `children` 可配置该`知识节点`下的子树结构信息,参考后面描述 + * 其中 `export` 可配置该`知识节点`下的导出习题信息,参考后面描述 + +## `知识节点` 子树信息结构 + +例如 `data/1.MySQL初阶/1.MySQL简介/1.HelloWorld/config.json` 里配置对该知识节点子树信息结构,这个配置是可选的: +```json +{ + // ... + + "children": [ + { + "XX开发入门": { + "keywords": [ + "XX开发", + ], + "children": [], + "keywords_must": [ + "XX" + ], + "keywords_forbid": [] + } + } + ], +} +``` + +## `知识节点` 的导出习题编辑 + +例如 `data/1.MySQL初阶/1.MySQL简介/1.HelloWorld/config.json` 里配置对该知识节点导出的习题 + +```json +{ + // ... + "export": [ + "helloworld.json" + ] +} +``` + +helloworld.json 的格式如下: +```bash +{ + "type": "code_options", + "author": "xxx", + "source": "helloworld.md", + "notebook_enable": false, + "exercise_id": "xxx" +} +``` + +其中 +* "type": "code_options" 表示是一个选择题 +* "author" 可以放作者的 CSDN id, +* "source" 指向了习题 MarkDown文件 +* "notebook_enable" 目前都是false +* "exercise_id" 是工具生成的,不填 + + +习题格式模版如下: + +````mardown +# {标题} + +{习题描述} + +以下关于上述游戏代码说法[正确/错误]的是? + +## 答案 + +{目标选项} + +## 选项 + +### A + +{混淆选项1} + +### B + +{混淆选项2} + +### C + +{混淆选项3} + +```` + +## 技能树合成 + +在根目录下执行 `python main.py` 会合成技能树文件,合成的技能树文件: `data/tree.json` +* 合成过程中,会自动检查每个目录下 `config.json` 里的 `node_id` 是否存在,不存在则生成 +* 合成过程中,会自动检查每个知识点目录下 `config.json` 里的 `export` 里导出的习题配置,检查是否存在`exercise_id` 字段,如果不存在则生成 +* 在 节 目录下根据需要,可以添加一些子目录用来测试代码。 +* 开始游戏入门技能树构建之旅,GoodLuck! \ No newline at end of file diff --git "a/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/config.json" "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/config.json" new file mode 100644 index 0000000000000000000000000000000000000000..b0dd4e9c9ea678b0b781ad70afd756c911ae64a3 --- /dev/null +++ "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/config.json" @@ -0,0 +1,10 @@ +{ + "node_id": "mysql-96403217971e4115835e31bba9366fcb", + "keywords": [], + "children": [], + "export": [ + "helloworld.json" + ], + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git "a/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.json" "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.json" new file mode 100644 index 0000000000000000000000000000000000000000..f6b9daae3c640b0bb50e18c85bb7e9fa2f4f32e9 --- /dev/null +++ "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.json" @@ -0,0 +1,7 @@ +{ + "type": "code_options", + "author": null, + "source": "helloworld.md", + "notebook_enable": false, + "exercise_id": "c58c8c60118e4603b5255168de60d79e" +} \ No newline at end of file diff --git "a/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.md" "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.md" new file mode 100644 index 0000000000000000000000000000000000000000..a447c184c7aaa9ee5f088c42158140caf4682c08 --- /dev/null +++ "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/1.HelloWorld/helloworld.md" @@ -0,0 +1,21 @@ +# {在此填写标题} + +{在此填写题目描述} + +## 答案 + +{在此填写答案} + +## 选项 + +### A + +{在此填写选项A} + +### B + +{在此填写选项B} + +### C + +{在此填写选项C} diff --git "a/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/config.json" "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/config.json" new file mode 100644 index 0000000000000000000000000000000000000000..1498d318d379a71df6000b59dcd2aacaaafbdb23 --- /dev/null +++ "b/data/1.MySQL\345\210\235\351\230\266/1.MySQL\345\205\245\351\227\250/config.json" @@ -0,0 +1,6 @@ +{ + "node_id": "mysql-2cd5f68281704161820ee048e1f9de36", + "keywords": [], + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git "a/data/1.MySQL\345\210\235\351\230\266/config.json" "b/data/1.MySQL\345\210\235\351\230\266/config.json" new file mode 100644 index 0000000000000000000000000000000000000000..159555b5cba3611f882afc2a1ec71bb2f47db4a5 --- /dev/null +++ "b/data/1.MySQL\345\210\235\351\230\266/config.json" @@ -0,0 +1,6 @@ +{ + "node_id": "mysql-a2097b15da334afeb39804bc57342da9", + "keywords": [], + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git "a/data/2.MySQL\344\270\255\351\230\266/config.json" "b/data/2.MySQL\344\270\255\351\230\266/config.json" new file mode 100644 index 0000000000000000000000000000000000000000..178c576ec209b104f4570099065881e064d84571 --- /dev/null +++ "b/data/2.MySQL\344\270\255\351\230\266/config.json" @@ -0,0 +1,6 @@ +{ + "node_id": "mysql-4ccd6a9874f147bc9e5f368e3bd90850", + "keywords": [], + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git "a/data/3.MySQL\351\253\230\351\230\266/config.json" "b/data/3.MySQL\351\253\230\351\230\266/config.json" new file mode 100644 index 0000000000000000000000000000000000000000..267d7f58c57d63acb986cc561588ae04ceaeb7f7 --- /dev/null +++ "b/data/3.MySQL\351\253\230\351\230\266/config.json" @@ -0,0 +1,6 @@ +{ + "node_id": "mysql-fba12490eaea4ed8b50866f878896338", + "keywords": [], + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git a/data/config.json b/data/config.json new file mode 100644 index 0000000000000000000000000000000000000000..b050253a5aa8b0131ddcc361652f3f42dfc9bd26 --- /dev/null +++ b/data/config.json @@ -0,0 +1,7 @@ +{ + "tree_name": "mysql", + "keywords": [], + "node_id": "mysql-5a1177c8ea254278855ed36089ddecd5", + "keywords_must": [], + "keywords_forbid": [] +} \ No newline at end of file diff --git a/data/tree.json b/data/tree.json new file mode 100644 index 0000000000000000000000000000000000000000..7188e42367aaba6fb97a67ca3263ab7ea95a0b65 --- /dev/null +++ b/data/tree.json @@ -0,0 +1,57 @@ +{ + "mysql": { + "node_id": "mysql-5a1177c8ea254278855ed36089ddecd5", + "keywords": [], + "children": [ + { + "MySQL初阶": { + "node_id": "mysql-a2097b15da334afeb39804bc57342da9", + "keywords": [], + "children": [ + { + "MySQL入门": { + "node_id": "mysql-2cd5f68281704161820ee048e1f9de36", + "keywords": [], + "children": [ + { + "HelloWorld": { + "node_id": "mysql-96403217971e4115835e31bba9366fcb", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [] + } + } + ], + "keywords_must": [], + "keywords_forbid": [] + } + } + ], + "keywords_must": [], + "keywords_forbid": [] + } + }, + { + "MySQL中阶": { + "node_id": "mysql-4ccd6a9874f147bc9e5f368e3bd90850", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [] + } + }, + { + "MySQL高阶": { + "node_id": "mysql-fba12490eaea4ed8b50866f878896338", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [] + } + } + ], + "keywords_must": [], + "keywords_forbid": [] + } +} \ No newline at end of file diff --git a/main.py b/main.py new file mode 100644 index 0000000000000000000000000000000000000000..d32ac3cac5e25c0f7d6d69c2964d4347b95a56c1 --- /dev/null +++ b/main.py @@ -0,0 +1,5 @@ +from skill_tree.tree import TreeWalker + +if __name__ == '__main__': + walker = TreeWalker("data", "mysql", "MySQL", ignore_keywords=True) + walker.walk() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..0abd88a12cb668d836c3bb780e4e88573f4d1d81 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +.pre_commit +skill-tree-parser \ No newline at end of file