From 6bf68d3503ae45077c348c823b932aab86502324 Mon Sep 17 00:00:00 2001 From: Tunghsiao Liu Date: Tue, 6 May 2014 08:43:50 +0800 Subject: [PATCH] feat(docs): add toc --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 9a625bf..8bb09d0 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,30 @@ - 使用正確的標點及正確的語法，增強網站氣質，給別人看了不丟人 - 統一蔽廠內部的標點用法，減少程序員、設計師之間的溝通成本 +**Table of Contents** + +- [空格（spacing）相關語法](#c1) + - [中英文之間需要增加空格](#c1-1) + - [中文與數字之間需要增加空格](#c1-2) + - [數字與單位之間需要增加空格](#c1-3) +- [標點符號相關語法](#c2) + - [中文排版時，一律使用全角（fullwidth）中文標點](#c2-1) + - [中英文混排時，一律使用全角（fullwidth）中文標點](#c2-2) + - [中英文混排時，遇到完整的英文整句，整句內容使用半角（halfwidth）標點](#c2-3) +- [大小寫相關語法](#c3) + - [專有名詞使用正確的大小寫](#c3-1) +- [尚存爭議的用法](#c100) +- [相關鏈接](#c101) +- [已踐行本用法的相關網站](#c102) + + ## 空格（spacing）相關語法 「有研究顯示，打字的時候不喜歡在中文和英文之間加空格的人，感情路都走得很辛苦，有七成的比例會在 34 歲的時候跟自己不愛的人結婚，而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。 與大家共勉之。」——[vinta/paranoid-auto-spacing](https://github.com/vinta/paranoid-auto-spacing) + ### 中英文之間需要增加空格 正確： @@ -26,6 +44,7 @@ 完整的正確用法： > 在 AVOS Cloud 上，数据存储是围绕 `AVObject` 进行的。每个 `AVObject` 都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的，你不需要在每个 `AVObject` 上提前指定存在哪些键，只要直接设定对应的 key-value 即可。 + ### 中文與數字之間需要增加空格 正確： @@ -38,6 +57,7 @@ > 今天出去買菜花了5000元 + ### 數字與單位之間需要增加空格 正確： @@ -48,8 +68,10 @@ > 我家的寬帶有 1Gbps，硬盤一共有 10TB。 + ## 標點符號相關語法 + ### 中文排版時，一律使用全角（fullwidth）中文標點 正確： @@ -62,6 +84,7 @@ > 嗨!你知道嘛?今天前台的小妹跟我說"喵"了哎! + ### 中英文混排時，一律使用全角（fullwidth）中文標點 正確： @@ -74,6 +97,7 @@ > 核磁共振成像(NMRI)是什麼原理都不知道？JFGI! + ### 中英文混排時，遇到完整的英文整句，整句內容使用半角（halfwidth）標點 正確： @@ -84,10 +108,12 @@ > 喬幫主那句話是怎麼說的？「Stay hungry，stay foolish。」 + ## 大小寫相關語法 大小寫相關用法原屬於英文書寫範疇，不屬於本 wiki 討論內容，在這裡只對部分易錯用法進行簡述 + ### 專有名詞使用正確的大小寫 正確： @@ -126,10 +152,12 @@ 注意：當網頁中需要配合整體視覺風格而出現全部大寫的情形，HTML 中請使用標準的大小寫規範進行書寫；並通過 `text-transform: uppercase;` 對形式進行定義 + ## 尚存爭議的用法 :exclamation: 以下用法略帶有個人色彩，既：無論是否遵循下述規則，從語法的角度來講都是**正確**的 + ### 中文鏈接之間增加空格 （個人推薦的）用法： @@ -144,6 +172,7 @@ > 訪問我們網站的最新動態，請[點擊這裡](#)進行訂閱！ + ## 相關鏈接 - [來自 About.com 的大小寫用法（英文）](http://grammar.about.com/od/punctuationandmechanics/a/Guidelines-For-Using-Capital-Letters.htm) @@ -152,6 +181,7 @@ - [來自普渡大學的標點符號用法（英文）](https://owl.english.purdue.edu/owl/section/1/6/) - [來自 wikiHow 的英文標點符號用法 wiki（英文）](http://www.wikihow.com/Use-English-Punctuation-Correctly) + ## 已踐行本用法的相關網站 網站 | 文案 | UGC