Skip to content

Commit ca68e8a

Browse files
Create README.md
1 parent 8d3eebf commit ca68e8a

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# 写新文章 / Write new tutorial
2+
`tutorial/src` 文件夹中提交 `comp-md` 格式的文件,后缀名为 `.md`
3+
4+
其中,`src`文件夹分三级,比如:`book1/section1/welcome.md`,其中第一级为书名/系列名,第二级为章节名,第三级为文章名。章节名和文章名均会显示在编译之后的教程页面中。
5+
6+
# Comp-md 格式 / The comp-md standard
7+
- 主体部分同 markdown 一样
8+
- 可以使用 `-----COMP_NAME-----` (前后均有五个`-`) 来启用组件
9+
- 组件各部分之间有一个空行
10+
- 组件以 `-----COMP_NAME-----` 标志结束
11+
12+
## 组件 / Components
13+
### choose
14+
调用方法:使用 `-----choose-----` 以调用该组件。
15+
16+
部分一:问题(纯文本,不可使用markdown语法)
17+
18+
部分二:选项(格式形如`- [ ] answer1`,注意空格。方括号内若有`*`则表示该选项为答案。组件会自动判定单选/多选题。)
19+
20+
示例:
21+
```markdown
22+
调用 `choose` 组件的示例:
23+
24+
-----choose-----
25+
What is the **answer** to the universe?
26+
27+
- [ ] 41
28+
- [*] 42
29+
- [ ] 43
30+
- [ ] 44
31+
-----choose-----
32+
```
33+

0 commit comments

Comments
 (0)