diff --git a/docs/content-guide.md b/docs/content-guide.md index ffbfcab1..edb566c0 100644 --- a/docs/content-guide.md +++ b/docs/content-guide.md @@ -1,8 +1,10 @@ -# 内容管理指南 +## 内容管理指南 本站除主页外的所有内容都是用 Markdown 格式文档编写，然后由 Hugo 渲染出 HTML 页面。所有的 Markdown 内容都保存在 `content` 目录下。 -## 默认模板 +Markdown规则与翻译规范参考[Markdown 语法规范](./markdown-guide.md)。 + +### 默认模板 创建博客的默认模版位于 `archetypes/default.md`。 @@ -46,7 +48,7 @@ keywords: [""] 注意：页面右侧的“分类”和“标签“显示的是所有博客的，而非当前博客页面的”分类“和”标签“。 -## 创建新的博客 +### 创建新的博客 如果需要创建新的博客，只需要运行下面的命令： @@ -57,7 +59,7 @@ touch content/blog/new-blog/index.md 打开 Markdown 文件，修改文档的元数据，然后就可以欢快的编辑内容了。 -## 创建新的 tab 页面 +### 创建新的 tab 页面 使用下面的命令创建新的 tab 页面： @@ -71,9 +73,9 @@ hugo new new-tab.md ```toml [[menu.main]] - name = "新的页面" - url = "/new-tab/" - weight = 6 + name = "新的页面" + url = "/new-tab/" + weight = 6 ``` - name：tab 显示在主页上的名称 diff --git a/docs/markdown-guide.md b/docs/markdown-guide.md new file mode 100644 index 00000000..d7de855f --- /dev/null +++ b/docs/markdown-guide.md @@ -0,0 +1,227 @@ +## Markdown ﷨淶 + +### ½ +``` +--- +title: This is the title ± +--- + +## This is heading 2 / + +### This is heading 3 / + +#### This is heading 4 / ļ + +``` + +- ±ֻĵ front matter ʹ `title` Զ塣ʹ heading 1 (`#`) +- ½ڱʹ heading 23 4ʹ heading 5 (`#####`) 㼶ı⡣ +- 㼶ʹã heading 2 µӱӦʹ heading 3 4 +- ֶӱšֶάɱ +- Ӣıʹ sentence caseֻĸרʴд + + +### + +``` + **Ӵ** Ҳ __Ӵ__ + + *б* + + ***Ӵб*** +``` + +- ܹؼʱʹ **Ӵ** *б* š +- ԪʹüӴֻб塣Ӧͳһʹڴ `code` ģʽԪأ + - ļ + - ļ· + - + - + - URL + +### б + + +бΪ **б** (ordered list) **б** (unordered list) + +- **б**ǿ˳бԻ˳Ӱʹбʹбڲȳ +- **б**˳ӰݡбҪбȳ + +**ʾ** +``` + ²贴̣ + 1. ׼ + - JDK 7 JDK 8 + - Apache Maven 3.2.5 ϰ汾 + 1. ģ + 1. Ӳ1 + 1. Ӳ2 + 1. xxx +``` +**** +²贴̣ + +1. ׼ + - JDK 7 JDK 8 + - Apache Maven 3.2.5 ϰ汾 +1. ģ + 1. Ӳ1 + 1. Ӳ2 +1. xxx + + +### + +ıֱӽͼ + + +### + +#### ڴ + +``` +ڹ̵ `pom.xml` ļ xxx +``` + +ʹڴǣ + - ļ + - ļ· + - + - + - URL + + + +#### + +``` +This is a code block +``` + +- ָ + ``` + \```java + ``` + + + \```xml + + + \```json + + \```sql + + ``` +- ռλ + ``` + $ cd /conf + ``` + + +### + +``` +> **˵** +> Ǹ˵ + + +> **Ҫ** +> ҪϢ + + +> **Ҫ** +> - Ҫʹøʽչʾݡ +> - б2 +``` + +> **Ҫ** ҪʹøʽչʾݡӦʹô \`\`\` ʽչʾ롣 + + +### ͼƬ + +- ͼƬͳһʹ `png` ʽԴļøͼ markdown ļͳһĿ¼¡ +- ȷͼƬжӦ˵ֹ©ͼƬеҪϢ +- ͼƬʱṩ alt text +- ҪԽͼʽṩʾ + +### + + +- ĵʹȫDZ㡣ҪӢı㡣 + `һӡThis is a sentence.` + `ʹʡԺš ...` +- Ӣ֮䱣һӢĿո `ĺ English words ֮䱣һո` + +### Ӣ + + + +## д + +### ô׼ȷ⸴Ӿʽ + +** "" / ""** +- ****can / couldʾûѡȨҲԲͨɡ + 磺`ͨ޸xxֵyy` ʣ޸IJֵǷΪyyõı벽裿ôĬģ޸IJǷõΨһʲôѡ +- ****mustʾҪӰ + 磺`Ҫʹ xxxڹ xxx ` ʾ޷ʹ xxx +- Ҫneedʹá + + +**ʹ һ㡱** +磺`һ` ָģʲô»⣿δ + + +### + +- `ûʲô,ʹü` ȥ仰Ӱ⣩ + + +### ﻯ + +### ȷʹ ġءá + +### ʹôʱҪȷָ󣬱 + + +- `Ϊ true` +- ȷ`xxxΪ true` + + +### ʹ ǡ + +ʹʹ / ڶ˳ơ + - 󣺡Ƿһ + - ȷ + + +### ʹд + +- Ϊж߶׶ĵʹȫơ磺ʹ Kubernetes, k8s +- д磺"i.e." "e.g." "etc." "et al." + +### ʹ䣬ⱻ̬ + +- `յ󣬷ʼִxxx` +- ȷ`յ󣬿ʼִxxx` + +**⣺** + +- ǿ״̬Ƕ磺`ȷļѱ档` +- ûбҪἰִߡ + +### ֱӣ񶨾䣬䲻Ҫʹ˫ط񶨾 + + +- `ûйԱȨ޵ûɾļ` +- ȷ`ҪɾļûӵйԱȨޡ` + + +### ˻ +- `xx߷Ҫִxxx` +- ȷ`` + +### ֹ漰Ա𡢷ɡĻ + +- Ҫʹá/ԱָĴʡȸдӣɱʱʹøǡߡû +- ҪἰʥڵضĻij \ No newline at end of file