# Markdown 书写规范

刘小标 2020-10-19

# 1 目录结构规范

目录结构样例规范要求： image-20201019111636224

# 2 标题及作者信息

image-20201019142510470

# 2 图片使用 GitLab 图床

详情参考，知识库中帮助页面下的的《图床使用说明》。

image-20201019112118851

# 3 插入代码片段

代码以插入代码块的方式放入文档。

image-20201019112613988

# 4 Markdown 文件命名

# 4.1 命名要求

文件名不要包含特殊字符，如“#”、“-”等符号，也不能含有空格哦。

# 4.2 分类要求

以分享目录为例说明：

展示目录：

image-20201019140741645

物理目录：

image-20201019135847743

命名规则：

单文件命名规则

类名_文件名.md，如"Java_CodeStandard.md"

系列文件命名规则

类名序号文件名.md，如"Java_01_CodeStandard.md"

编辑此页面

研发二部图床使用说明 >

数据中心 研发二部