提交 9434f39e 编写于 作者: F feilong

update readme

上级 874da9ed
# skill_tree_toolchains # skill_tree_web_in_action
全栈工具链
`Web实战技能树`[技能树森林](https://gitcode.net/csdn/skill_tree)的一部分。
## 初始化 ## 初始化
``` ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
## 目录结构说明 ## 目录结构说明
* 技能树`骨架文件` * 技能树`骨架文件`
* 位置:`data/tree.json` * 位置:`data/tree.json`
* 说明:该文件是执行 `python main.py` 生成的,请勿人工编辑 * 说明:该文件是执行 `python main.py` 生成的,请勿人工编辑
* 技能树`根节点`配置文件: * 技能树`根节点`配置文件:
* 位置:`data/config.json` * 位置:`data/config.json`
* 说明:可编辑配置关键词等字段,其中 `node_id` 字段是生成的,请勿编辑 * 说明:可编辑配置关键词等字段,其中 `node_id` 字段是生成的,请勿编辑
* 技能树`难度节点` * 技能树`难度节点`
* 位置:`data/xxx`,例如: `data/1.toolchains初阶` * 位置:`data/xxx`,例如: `data/1.Web实战初阶`
* 说明: * 说明:
* 每个技能树有 3 个等级,目录前的序号是必要的,用来保持文件夹目录的顺序 * 每个技能树有 3 个等级,目录前的序号是必要的,用来保持文件夹目录的顺序
* 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑 * 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑
* 技能树`章节点` * 技能树`章节点`
* 位置:`data/xxx/xxx`,例如:`data/1.toolchains初阶/1.git` * 位置:`data/xxx/xxx`,例如:`data/1.Web实战初阶/1.git`
* 说明: * 说明:
* 每个技能树的每个难度等级有 n 个章节,目录前的序号是必要的,用来保持文件夹目录的顺序 * 每个技能树的每个难度等级有 n 个章节,目录前的序号是必要的,用来保持文件夹目录的顺序
* 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑 * 每个目录下有一个 `config.json` 可配置关键词信息,其中 `node_id` 字段是生成的,请勿编辑
* 技能树`知识节点` * 技能树`知识节点`
* 位置:`data/xxx/xxx/xxx`,例如:`data/1.toolchains初阶/1.git/3.push修改到远程创库` * 位置:`data/xxx/xxx/xxx`,例如:`data/1.Web实战初阶/1.git/3.push修改到远程创库`
* 说明: * 说明:
* 每个技能树的每章有 `n` 个知识节点,目录前的序号是必要的,用来保持文件夹目录的顺序 * 每个技能树的每章有 `n` 个知识节点,目录前的序号是必要的,用来保持文件夹目录的顺序
* 每个目录下有一个 `config.json` * 每个目录下有一个 `config.json`
* 其中 `node_id` 字段是生成的,请勿编辑 * 其中 `node_id` 字段是生成的,请勿编辑
* 其中 `keywords` 可配置关键字字段 * 其中 `keywords` 可配置关键字字段
* 其中 `children` 可配置该`知识节点`下的子树结构信息,参考后面描述 * 其中 `children` 可配置该`知识节点`下的子树结构信息,参考后面描述
* 其中 `export` 可配置该`知识节点`下的导出习题信息,参考后面描述 * 其中 `export` 可配置该`知识节点`下的导出习题信息,参考后面描述
## `知识节点` 子树信息结构 ## `知识节点` 子树信息结构
例如 `data/1.toolchains初阶/1.git/4.push修改到远程创库/config.json` 里配置对该知识节点子树信息结构: 例如 `data/1.Web实战初阶/1.git/4.push修改到远程创库/config.json` 里配置对该知识节点子树信息结构:
```json ```json
{ {
// ... // ...
"children": [ "children": [
// TODO ... // TODO ...
], ],
} }
``` ```
## `知识节点` 的导出习题编辑 ## `知识节点` 的导出习题编辑
例如 `data/1.toolchains初阶/1.git/4.push修改到远程创库/config.json` 里配置对该知识节点导出的习题 例如 `data/1.Web实战初阶/1.git/4.push修改到远程创库/config.json` 里配置对该知识节点导出的习题
```json ```json
{ {
// ... // ...
"export": [ "export": [
"hello.sh" "hello.sh"
] ]
} }
``` ```
格式说明:
* `file`: 指定该目录下的习题源文件
* `variants`: 指定习题同名的json选项配置文件,参考下一节
* `depends`: 如果习题依赖同目录下的其他习题源代码,则在此字段里配置依赖的其他习题源文件名
## `知识节点` 的导出习题选项配置编辑 ## `知识节点` 的导出习题选项配置编辑
如前内容,我们在知识节点下增加一个习题定义,例如在 `data/1.toolchains初阶/1.git/4.push修改到远程创库` 下增加一个`hello.json`代码: 如前内容,我们在知识节点下增加一个习题定义,例如在 `data/1.Web实战初阶/1.git/4.push修改到远程创库` 下增加一个`hello.json`代码:
```json ```json
{ {
"type": "code_options", "type": "code_options",
"author": "刘鑫", "author": "刘鑫",
"source": "hello.md", "source": "hello.md",
"notebook_enable": false "notebook_enable": false
} }
``` ```
其中 type 字段目前都固定是 `code_options`。根据具体情况写好其它字段,注意这里 source 的文件名,我们指定了一个 markdwon 文件。现在我们新建一个 HelloWorld.md 并编辑为: 其中 type 字段目前都固定是 `code_options`。根据具体情况写好其它字段,注意这里 source 的文件名,我们指定了一个 markdwon 文件。现在我们新建一个 HelloWorld.md 并编辑为:
````markdown ````markdown
...@@ -130,6 +123,4 @@ $ git pull origin master ...@@ -130,6 +123,4 @@ $ git pull origin master
```` ````
这是一个最基本的习题结构,它包含标题、答案、选项,注意这几个一级和二级标题必须填写正确,解释器会读取这几个标题。而选项的标题会被直接忽略掉,在 这是一个最基本的习题结构,它包含标题、答案、选项,注意这几个一级和二级标题必须填写正确,解释器会读取这几个标题。而选项的标题会被直接忽略掉,在
最终生成的习题中不包含选项的三级标题,所以这个标题可以用来标注一些编辑信息,例如“此选项没有关闭文件连接”,“类型错误”等等。 最终生成的习题中不包含选项的三级标题,所以这个标题可以用来标注一些编辑信息,例如“此选项没有关闭文件连接”,“类型错误”等等。
\ No newline at end of file
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
"keywords": [], "keywords": [],
"children": [ "children": [
{ {
"toolchains初阶": { "Web实战初阶": {
"node_id": "toolchains-87f33f689f5e4f05a65f344faa2022cb", "node_id": "toolchains-87f33f689f5e4f05a65f344faa2022cb",
"keywords": [], "keywords": [],
"children": [ "children": [
...@@ -184,7 +184,7 @@ ...@@ -184,7 +184,7 @@
} }
}, },
{ {
"toolchains中阶": { "Web实战中阶": {
"node_id": "toolchains-979177e2db87470cb604783444e47175", "node_id": "toolchains-979177e2db87470cb604783444e47175",
"keywords": [], "keywords": [],
"children": [ "children": [
...@@ -404,7 +404,7 @@ ...@@ -404,7 +404,7 @@
} }
}, },
{ {
"toolchains高阶": { "Web实战高阶": {
"node_id": "toolchains-86e5c506fc34422491c049db4c45e39e", "node_id": "toolchains-86e5c506fc34422491c049db4c45e39e",
"keywords": [], "keywords": [],
"children": [] "children": []
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册