docs: propose code of naming document
This commit is contained in:
@@ -25,6 +25,52 @@
|
|||||||
- 网站页面设计
|
- 网站页面设计
|
||||||
- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
|
- 在各种媒体、博客文章、群内宣传 HDU-CS-WIKI
|
||||||
|
|
||||||
|
## 文档命名
|
||||||
|
|
||||||
|
1. 对于 md 文件,请命名为 `数字与小数点前缀+文档标题` 的格式
|
||||||
|
|
||||||
|
```
|
||||||
|
1.1.2 新内容.md
|
||||||
|
2. 序言.md
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 如果您需要开启新的小章节模块,请新建一个文件夹,文件夹的命名格式与 md 文件类似,为 `数字与小数点前缀+模块名`
|
||||||
|
|
||||||
|
```
|
||||||
|
2.2 模块 2
|
||||||
|
```
|
||||||
|
|
||||||
|
3. 不论是 md 文件还是文件夹,请不要使用字母或其他特殊符号作为前缀
|
||||||
|
|
||||||
|
一个合理的文档结构如下:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
└─ 1.第一章
|
||||||
|
├── 1.1 模块 1
|
||||||
|
│ ├── 1.1.10 JavaScript.md
|
||||||
|
│ ├── 1.1.11 Lua.md
|
||||||
|
│ ├── 1.1.12 Lisp.md
|
||||||
|
│ ├── 1.1.1 Ruby.md
|
||||||
|
│ ├── 1.1.2 Java.md
|
||||||
|
│ ├── 1.1.3 C++.md
|
||||||
|
│ ├── 1.1.4 C.md
|
||||||
|
│ ├── 1.1.5 Math.md
|
||||||
|
│ ├── 1.1.6 Matlab.md
|
||||||
|
│ ├── 1.1.7 React.md
|
||||||
|
│ ├── 1.1.8 Jupyter.md
|
||||||
|
│ └── 1.1.9 Vue.md
|
||||||
|
├── 1.2 模块 2
|
||||||
|
│ ├── 1.2.1 C#.md
|
||||||
|
│ ├── 1.2.2 Python.md
|
||||||
|
│ └── static
|
||||||
|
├── 1.3 结语.md
|
||||||
|
├── 1. 序言.md
|
||||||
|
└── static
|
||||||
|
```
|
||||||
|
|
||||||
|
static 文件夹用于存放您的静态资源,如图片,您也可以在模块文件夹下放置新的 static 文件夹,方便引用资源
|
||||||
|
|
||||||
## 文档风格
|
## 文档风格
|
||||||
|
|
||||||
1. 使用 Markdown 编写文档,文档格式参考 Markdown 语法。
|
1. 使用 Markdown 编写文档,文档格式参考 Markdown 语法。
|
||||||
|
|||||||
Reference in New Issue
Block a user