Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 1.54 KB

2.文章格式规范.md

File metadata and controls

78 lines (44 loc) · 1.54 KB

文章格式规范

所有文章我们统一用 markdown 来编写,markdown 的用法在这里:Mastering Markdown · GitHub Guides

文件名

文件名的规则待定

标题

文章的第一行是文章标题,标题和文件名完全一致。

标题用 H1 大小(#)。

正文

分段

正文中的分段用不同的 # 数来分级,其中最高级为 H2(##)。

普通正文

直接写。

列表

  • 直接写就好。

  • 列表中的折行记得缩进。

    就像这样。

而不是这样。

代码块

代码块记得标注语言类型,即这样写:

```java
public class User {

}
```

而不是这样写:

```
public class User {

}
```

图片

图床的链接不要使用在国内有访问性或访问速度问题的。如果没有自己习惯的方案,可以试试路过图床

英文和数字

中文、英文和数字之间加空格。英文和标点、数字和标点之间加不加可以看情况而定,暂时不要求吧。例如要这样:

自从 Kotlin 发布以来,我就再也不写 Java 了,因为我怕别人发现我没学会 Java 1.8。

而不是:

自从Kotlin发布以来,我就再也不写Java了,因为我怕别人发现我没学会Java1.8。

其他

待补充(或不再补充)

示例

文章模板