Merge pull request #92 from ic123-xyz/update-style-guide

Update style guide

docusaurus/docs/about/3-styling-guide/index.md

@@ -4,7 +4,7 @@ ic123.xyz 欢迎所有对互联网计算机 / ICP 感兴趣的朋友来参与网
 
 在开始编辑文章之前，请先仔细阅读本文，了解 ic123.xyz 网站对文章风格的要求以及规范。
 
-## 通用
+## 通用 {#general}
 
 1. **`DFINITY`** 是唯一正确的拼写 - 七个字母都需要大写。
 2. 所有的 markdown 文件名全部`小写`，不要有任何**空格**，使用 `英文`，文件名里的单词统一用 `-` 连接，不要用 `_`（在URL里看不清楚），以 `md` 为统一后缀。
@@ -17,7 +17,7 @@ ic123.xyz 欢迎所有对互联网计算机 / ICP 感兴趣的朋友来参与网
 9. [Tag](https://ic123.xyz/blog/tags) 统一用小写。
 10. 不需要使用 `icp`，`ic`，或者 `internet computer`, `互联网计算机` 这样的tag。整个本网站都是讲 ic 的。
 
-## 文章原子结构
+## 文章原子结构 {#article-structure}
 
 建议每篇文章按照以下的原子结构搭建，以实现所有的内容自成一体，便于迁移。
 
@@ -41,12 +41,12 @@ ic123.xyz 欢迎所有对互联网计算机 / ICP 感兴趣的朋友来参与网
 
 如果文章里没有引用图片，可以省去文件夹的结构，直接就用 `hello-icp-my-old-friend.md` 就可以了。
 
-## 图片格式
+## 图片格式 {#image-format}
 
 1. 建议图片的 `width` 统一设置为 `800px` (Resolution = 72)。这样每张图片大小应该在 200-300KB 之间。图片尺寸太大的话只会增加下载的时间，降低网页调用的速度。
 2. 图片可以用 `.jpg`，`jpeg`, `.png`, `.PNG` 等通用格式。
 
-## 文章的路径
+## 文章的路径 {#article-path}
 
 每位作者需要做的第一个决定，就是文件夹（文件）应该放在哪条路径下面。
 
@@ -73,7 +73,7 @@ Docusaurus 的架构中，会被社区内容贡献者用到的文件夹有两个
 
 请在 `ic123 工作组` 里联系管理员，确认文件应该归属的路径。
 
-## 新闻文章 (blog)
+## 新闻文章 (blog) {#blog-post}
 
 如果文章是[新闻](http://localhost:3000/blog)类型，除了遵循上述通用的文件夹原子结构以外，还需要注意几点。
 
@@ -121,11 +121,14 @@ Docusaurus 的架构中，会被社区内容贡献者用到的文件夹有两个
 5. 每篇文章都必须添加文章的 summary ，否则[新闻](http://ic123.xyz/blog)无法展示所有的博客文章的索引。假设 `blog`下有一百篇文章，只要有一篇文章没有使用 `<!--truncate-->`，就会打乱整个 `blog` 的索引呈现。
 
     用 `<!--truncate-->` 来隔断 summary 跟正文的内容。所有放在 `<!--truncate-->` 的文字，包括图片，将被展示在新闻的索引页面上。Summary 通常一句话介绍一下文章的主要内容就行。
+
+    **请注意**：`<!--truncate-->` 之前不要有空格。请不要写成` <!--truncate-->`，否则 `Docusaurus` 构建会失败。
+
 6. 因为文章的标题已经在 front matter 里被 `title` 所定义，在文章正文里就不再需要使用 `#` 来定义文章的标题了，直接使用 `##` 来分级就可以了。
 7. 整篇文章在 commit 的时候，最重要的是 `slug`，因为它决定了文章的 URL 以及后续的 SEO (搜索引擎的搜索效率)。文章的其他部分都可以在初始 commit 之后继续更改而不影响文章在互联网和社交媒体上的有效传播。
 
 
-## 非新闻文章 (docs)
+## 非新闻文章 (docs) {#docs}
 
 非新闻类/docs 的文章会稍微简单一些。除了依旧遵循上述的文件夹原子结构以外，还需要注意几点。
 
@@ -134,7 +137,7 @@ Docusaurus 的架构中，会被社区内容贡献者用到的文件夹有两个
 3. 文章的作者将直接在网页下方显示（包括时间戳），按照最后递交 PR ，被 merge 了的 commit 作者为准。
 4. 整篇文章在 commit 的时候，最重要的是 `my-dear-icp` 部分，因为它决定了文章的 URL 以及后续的 SEO (搜索引擎的搜索效率)。文章的其他部分都可以在初始 commit 之后继续更改而不影响文章在互联网和社交媒体上的有效传播。
 
-## Markdown 文本编辑功能
+## Markdown 文本编辑功能 {#markdown-features}
 
 下面介绍一些在 Docusaurus 中常用的 Markdown 文本编辑功能。