From 4edcef043a2a5023238de6f153a79ec86c5b03c2 Mon Sep 17 00:00:00 2001 From: yanglbme Date: Sat, 13 Apr 2019 20:51:09 +0800 Subject: [PATCH] docs(from-readers): update doocs-advanced-java-attention.md --- docs/from-readers/doocs-advanced-java-attention.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/from-readers/doocs-advanced-java-attention.md b/docs/from-readers/doocs-advanced-java-attention.md index cbf170d..1d4e388 100644 --- a/docs/from-readers/doocs-advanced-java-attention.md +++ b/docs/from-readers/doocs-advanced-java-attention.md @@ -2,7 +2,7 @@ 项目需要有一个统一的内容提交规范，没有规范的项目将会是一团乱麻，维护起来也会很费劲儿。以下列出了几个小点，看似很多，实则非常容易做到，供朋友们参考。 ## 关于文件命名与存放位置 -文件请以 “`GitHub ID` + 文章主题” 命名，确保每位朋友的提交内容不会冲突。文章主题统一采用**英文**命名，请勿使用中文或者中式英语，文件类型统一选择 `.md`。 +文件请以 “`GitHub ID` + 文章主题” 命名，确保每位朋友的提交内容不会冲突。文章主题统一采用**英文**命名，请勿使用中文或者汉语拼音，文件类型统一选择 `.md`。 给个示例。某位朋友的 GitHub ID 是 [SnailClimb](https://github.com/snailclimb)，想分享一篇关于 Kafka 实践相关的文章，那么文件名可以是 `snailclimb-kafka-in-action.md`。 @@ -16,7 +16,7 @@ > 有研究显示，打字的时候不喜欢在中文和英文之间加空格的人，感情路都走得很辛苦，有七成的比例会在 34 岁的时候跟自己不爱的人结婚，而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。 -图片统一使用 `![](/images/xxx.png)` 进行相对引用，并同时存放于根目录 `images` 和本专区目录 `from-readers/images` **两个位置**（这是为了在 GitHub 和 GitHub Page 都能正常显示图片；图片并不限定 `.png` 格式），作图推荐使用在线工具 [ProcessOn](https://www.processon.com/i/594a16f7e4b0e1bb14fe2fac)。具体文章书写规范请参考《[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)》。 +图片统一使用 `![](/images/xxx.png)` 进行相对路径的引用，并同时存放于根目录 `images/` 和本专区目录 `from-readers/images/` **两个位置**之下（这是为了确保在 GitHub 和 GitHub Page 都能正常显示图片；图片并不限定 `.png` 格式），作图推荐使用在线工具 [ProcessOn](https://www.processon.com/i/594a16f7e4b0e1bb14fe2fac)。具体文章书写规范请参考《[中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide)》。 以下是文章基本的结构，供朋友们参考。 -- GitLab