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 f7783caedfc8d2b80f5bf32aadcd8d16d40f43dc..80bcf577106de2caef9c1bad78e1dcf9691d0acc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,152 @@ # skill_tree_opensource -开源软件开发 技能树 \ No newline at end of file +`开源软件开发技能树`是[技能森林](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.开源软件开发初阶` + * 说明： + * 每个技能树有 3 个等级，目录前的序号是必要的，用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` 可配置关键词信息，其中 `node_id` 字段是生成的，请勿编辑 +* 技能树`章节点`： + * 位置：`data/xxx/xxx`，例如：`data/1.开源软件开发初阶/1.开源软件开发简介` + * 说明： + * 每个技能树的每个难度等级有 n 个章节，目录前的序号是必要的，用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` 可配置关键词信息，其中 `node_id` 字段是生成的，请勿编辑 +* 技能树`知识节点`： + * 位置：`data/xxx/xxx`，例如：`data/1.开源软件开发初阶/1.开源软件开发简介` + * 说明： + * 每个技能树的每章有 n 个知识节点，目录前的序号是必要的，用来保持文件夹目录的顺序 + * 每个目录下有一个 `config.json` + * 其中 `node_id` 字段是生成的，请勿编辑 + * 其中 `keywords` 可配置关键字字段 + * 其中 `children` 可配置该`知识节点`下的子树结构信息，参考后面描述 + * 其中 `export` 可配置该`知识节点`下的导出习题信息，参考后面描述 + +## `知识节点` 子树信息结构 + +例如 `data/1.开源软件开发初阶/1.开源软件开发简介/1.HelloWorld/config.json` 里配置对该知识节点子树信息结构，这个配置是可选的： +```json +{ + // ... + + "children": [ + { + "XX开发入门": { + "keywords": [ + "XX开发", + ], + "children": [], + "keywords_must": [ + "XX" + ], + "keywords_forbid": [] + } + } + ], +} +``` + +## `知识节点` 的导出习题编辑 + +例如 `data/1.开源软件开发初阶/1.开源软件开发简介/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! + +## FAQ + +**难度目录是固定的么？** + +1. data/xxx 目录下的子目录是固定的初/中/高三个难度等级目录 + +**如何增加章目录？** + +1. 在VSCode里打开项目仓库 +2. 在对应的难度等级目录新建章目录，例如在 data/1.xxx初阶/ 下新建章文件夹，data/1.xxx初阶/1.yyy +3. 在项目根目录下执行 python main.py 脚本，会自动生成章的配置文件 data/1.xxx初阶/1.yyy/config.json + +**如何增加节目录?**: +1. 直接在VSCode里创建文件夹，例如 "data/1.xxx初阶/1.yyy/2.zzz" +2. 项目根目录下执行 python main.py 会自动为新增节创建配置文件 data/1.xxx初阶/1.yyy/2.zzz/config.json + +**如何在节下新增一个习题**: +3. 在"data/1.xxx初阶/1.yyy/2.zzz" 目录下添加一个 markdown 文件编辑，例如 yyy.md，按照习题markdown格式编辑习题。 +4. md编辑完后，可以再次执行 python main.py 会自动生成同名的 yyy.json，并将 yyy.json 添加到config.json 的export数组里。 +5. yyy.json里的author信息放作者 CSDN ID。 \ No newline at end of file diff --git "a/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/config.json" "b/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/config.json" index e2d32a91371cd5357717bc556afd5a40ce44eb69..715f0274a49c1ecb0cbaaa2a2c05453df779472c 100644 --- "a/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/config.json" +++ "b/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/config.json" @@ -2,7 +2,9 @@ "node_id": "opensource-094c04c42ae948de8bf39e31a8a5c7b4", "keywords": [], "children": [], - "export": [], + "export": [ + "helloworld.json" + ], "keywords_must": [], "keywords_forbid": [], "group": 0 diff --git "a/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/helloworld.json" "b/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/helloworld.json" new file mode 100644 index 0000000000000000000000000000000000000000..d7011e07151e7617ae2b0e2781e8dedbd95ea8e9 --- /dev/null +++ "b/data/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\210\235\351\230\266/1.\345\274\200\346\272\220\350\275\257\344\273\266\345\274\200\345\217\221\345\205\245\351\227\250/1.HelloWorld/helloworld.json" @@ -0,0 +1,7 @@ +{ + "type": "code_options", + "author": "feilong", + "source": "helloworld.md", + "notebook_enable": false, + "exercise_id": "597bac874a424816865711ecc69d2ce8" +} \ No newline at end of file diff --git a/data/tree.json b/data/tree.json new file mode 100644 index 0000000000000000000000000000000000000000..3ae8357124c194be7ea7058a05079ec717d4f2fa --- /dev/null +++ b/data/tree.json @@ -0,0 +1,63 @@ +{ + "opensource": { + "node_id": "opensource-52a37d65c4204f1fb06f1e57ece6e8c0", + "keywords": [], + "children": [ + { + "开源软件开发初阶": { + "node_id": "opensource-4c0e02f2b0104673a81a0f97f0955751", + "keywords": [], + "children": [ + { + "开源软件开发入门": { + "node_id": "opensource-63818b6f3eb246c0a276ca81f2fceab1", + "keywords": [], + "children": [ + { + "HelloWorld": { + "node_id": "opensource-094c04c42ae948de8bf39e31a8a5c7b4", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } + } + ], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } + } + ], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } + }, + { + "开源软件开发中阶": { + "node_id": "opensource-0acdb03055e64e15a791eab00b7041ee", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } + }, + { + "开源软件开发高阶": { + "node_id": "opensource-62af5876999648b58554ca549d49154b", + "keywords": [], + "children": [], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } + } + ], + "keywords_must": [], + "keywords_forbid": [], + "group": 0 + } +} \ No newline at end of file diff --git a/main.py b/main.py index f5cbe96933ab621ba70c385a131fb60d434ccc12..1c2c8323c1f5f3e8791c4038f6661d0abb297b67 100644 --- a/main.py +++ b/main.py @@ -1,5 +1,5 @@ from skill_tree.tree import TreeWalker if __name__ == '__main__': - walker = TreeWalker("data", "opensource", "开源软件开发") - walker.walk() + walker = TreeWalker("data", "opensource", "开源软件开发", ignore_keywords=True) + walker.init() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..650b949429614945604eb6ba09404b0ecd734fda --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +pre_commit +skill-tree-parser \ No newline at end of file