Skip to content

Commit 6636693

Browse files
committed
docs: propose code of naming document
1 parent fb276b2 commit 6636693

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,52 @@
2525
- 网站页面设计
2626
- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
2727

28+
## 文档命名
29+
30+
1. 对于 md 文件,请命名为 `数字与小数点前缀+文档标题` 的格式
31+
32+
```
33+
1.1.2 新内容.md
34+
2. 序言.md
35+
```
36+
37+
2. 如果您需要开启新的小章节模块,请新建一个文件夹,文件夹的命名格式与 md 文件类似,为 `数字与小数点前缀+模块名`
38+
39+
```
40+
2.2 模块 2
41+
```
42+
43+
3. 不论是 md 文件还是文件夹,请不要使用字母或其他特殊符号作为前缀
44+
45+
一个合理的文档结构如下:
46+
47+
```
48+
.
49+
└─ 1.第一章
50+
   ├── 1.1 模块 1
51+
   │   ├── 1.1.10 JavaScript.md
52+
   │   ├── 1.1.11 Lua.md
53+
   │   ├── 1.1.12 Lisp.md
54+
   │   ├── 1.1.1 Ruby.md
55+
   │   ├── 1.1.2 Java.md
56+
   │   ├── 1.1.3 C++.md
57+
   │   ├── 1.1.4 C.md
58+
   │   ├── 1.1.5 Math.md
59+
   │   ├── 1.1.6 Matlab.md
60+
   │   ├── 1.1.7 React.md
61+
   │   ├── 1.1.8 Jupyter.md
62+
   │   └── 1.1.9 Vue.md
63+
   ├── 1.2 模块 2
64+
   │   ├── 1.2.1 C#.md
65+
   │   ├── 1.2.2 Python.md
66+
│ └── static
67+
   ├── 1.3 结语.md
68+
   ├── 1. 序言.md
69+
   └── static
70+
```
71+
72+
static 文件夹用于存放您的静态资源,如图片,您也可以在模块文件夹下放置新的 static 文件夹,方便引用资源
73+
2874
## 文档风格
2975

3076
1. 使用 Markdown 编写文档,文档格式参考 Markdown 语法。

0 commit comments

Comments
 (0)