记录笔记的风格

文件名风格

• 后缀使用小写
• 同时有中英文，英文两边加空格
• 使用连字符 -，而非下划线或驼峰，连字符是现在最流行的网址分隔符

主题风格

• 建议 ## 二级标题之间可多加一行空格
• 名称由 {大标题序号}.{小标题序号}.{标题} 组成，若文章无序从任意位置查看都可以 ( 比如这篇 ) 可不要序号

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# Title
引言

## 1.相关见闻
	介绍、说明
	### 1.1.小标题

## 2.基础内容
	### 2.1.小标题
	### 2.2.小标题

## 3.使用案例
	### 3.1.小标题
	### 3.2.小标题

代码块

Golang 代码块示例

1
2
3

func main(){
  fmt.Println("hi")
}

Golang 代码 markdown 格式，注意右上角标明 go 语言

1
2
3
4
5

```go
func main(){
	fmt.Println("hi")
}
​```

Javascript 代码格式

1
2
3

```js
console.log("hi")
​```

html 代码格式

1
2
3
4
5

```css
.body{
	padding: 0px;
}
​```

引号使用场景

使用中文的 「」 描述

描述步骤

1

「系统偏好设置 - 键盘 - 输入法」

描述快捷键

1

「Command + Control + 空格键」     这是表情符号窗口

描述属性

使用表格

1
2
3

| 属性说明 | 值/示例 |
|  :----   | :----  |
| xxx     | xxx   |

清单

• 一个大工程
  • 子项工程 1
  • 子项工程 2

1
2
3

- [ ] 一个大工程
	- [ ] 子项工程 1
	- [ ] 子项工程 2

表达

• 一个段落只表达一个主题
• 避免连续使用松散的句子
• 使用相同的结构表达并列的意思
• 将强调的词放在句末

补充说明

• {} 大括号内的内容是变量名, 需要替换成适当的值。

• 为方便写代码等，设置输入法「偏好设置 - 中文下使用英文标点」，如需中文符号有下面两种解决方案。

  • 快捷键 「control + command + .」快速开关该功能。

• 使用第三方软件控制快捷键，针对个别符号设置快捷键，该方法未找到合适的软件( for mac )。

  • 使用输入法的「自定义短语设置」。