使用markdown组织你的技术笔记
每个热衷于技术的人对写作都会有需求,但是在传统的写作会存在这样的问题:- 纯文本不够强大
-
word又太过重量级,而且通用性差
-
你总要停下敲击键盘去选中并设置格式
基于以上的问题MarkDown似乎成了不二之选
-
基于纯文本的,兼容性极强,你可以用任何文本编辑器打开并编辑
-
让你专注于文字而不是排版
-
格式转换方便,你可以轻易的把Markdown的文本转换成 html,pdf等
-
Markdown的标记语言可读性非常强,编写也非常简单(相对于HTML)
-
可以利用出色的编辑器导出各种格式
可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成.(比html要好很多)
分割线
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:
代码:```
分割线
分割线
分割线
效果:
* * *
分割线
***
分割线
*****
分割线
- - -
###强调
Markdown 使用星号`*`和底线`_`作为标记强调字词的符号,被 * 或 _ 包围的字词会被转成用 `<em>` 标签包围,用两个 * 或 _ 包起来的话,则会被转成 `<strong>`,例如:
代码:
single asterisks
single underscores
double asterisks
double underscores```效果:
single asterisks
single underscores
double asterisks
double underscores
你可以随便用你喜欢的样式,唯一的限制是,你用什么符号开启标签,就要用什么符号结束。
强调也可以直接插在文字中间:
unfriggingbelievable
但是如果你的 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号。
如果要在文字前后直接插入普通的星号或底线,你可以用反斜线:
*this text is surrounded by literal asterisks*
虽然MarkDown 是一种语法格式,但是我们如果要高效率的使用,最好的方式还是选择一款编辑器,编辑器非常多,这里使用的 GitBook Editor ,可以对书籍进行版本管理.下载网址是:
https://www.gitbook.com/editor
当然,这是一个开源的项目,你可以在 https://github.com/GitbookIO/editor/查看源码
当然,大家可以选择自己的合适的编辑工具然后+Dropbox或者同步盘的方式同步自己的数据.
打开 Editor ,关联你的账号,你就可以放心的工作了. Editor的预览模式可以很清晰的告诉你将来你书籍的效果.
工具准备妥善,我们开始来看看他的语法,正如之前所说,Markdown的语法非常简单,我相信,在30分钟之内,你就能完全掌握:
标题
这是最为常用的格式,在平时常用的的文本编辑器中大多是这样实现的:输入文本、选中文本、设置标题格式.
而在 Markdown 中,你只需要在文本前面加上 # 即可,同理、你还可以增加二级标题、三级标题、四级标题、五级标题和六级标题,总共六级,只需要增加 # 即可,标题字号相应降低。例如:
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果如下:
一级标题
二级标题
三级标题
四级标题
还可以这样定义标题
或者这样定义
请注意,所有前置的符号,比如 '#' 最好和文本之间有一个空格的分隔,这是最标准的 Markdown 写法
正如你现在看到的,Markdown 是兼容 html标签的
列表
列表格式也很常用,在 Markdown 中,你只需要在文字前面加上 - 就可以了,例如:
- 文本1
- 文本2
- 不加空格的话,是没法显示的
如果想实现有序的列表的话,直接 1. 文本这样即可1. 文本12. 文本2
链接
语法格式[显示文本](链接地址) 例如[MarkDown](http://www.baidu.com)
效果:
如果是插入图片:只需要前面加一个 !,这个网络图片相信不用多说了.如果是本地图片,可以使用 路径代替链接地址即可
引用
在我们写作的时候经常需要引用他人的文字,这个时候引用这个格式就很有必要了,在 Markdown 中,你只需要在你希望引用的文字前面加上 >
就好了,例如:
一盏灯, 一片昏黄; 一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。
注:> 和文本之间要保留一个字符的空格。
粗体和斜体
Markdown 的粗体和斜体也非常简单,用两个 * 包含一段文本就是粗体的语法,用一个 * 包含一段文本就是斜体的语法。例如:
一盏灯, 一片昏黄;一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。
最终显示的就是下文,其中「一盏灯」是斜体,「一简书」是粗体
加粗还可以使用两个下划线的形式:
加粗
代码
单行代码可以使用 四个空格或者一个 tab的方式
four spaces
tab
对于多行代码,可以使用:
code here
图片
![Alt text](/path/to/image.jpg)
![Alt text](/path/to/image.png "Optional title attribute")
![Alt text](/url/to/image.jpg)
以上是简单的用法
#
反斜杠
Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 标签),你可以在星号的前面加上反斜杠:
*literal asterisks*
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:``\ 反斜线
反引号* 星号_ 底线{} 花括号[] 方括号() 括弧
井字号
- 加号
- 减号. 英文句点! 惊叹号```
语法
加粗和强调
对字符的描述都不包括 " "
使用 ** 进行加粗 或者 使用 __ 进行 加粗
使用 * 进行 强调 或者使用 _ 进行 强调
**有时候,我想加粗许多文本. 比如, 真的, _许多_ 文本**
效果:有时候,我想加粗许多文本. 比如, 真的, 许多 文本
引用
Right angle brackets > are used for block quotes.
使用 >
进行段引用
效果:
表示引用,可以一段话只在段落的开头加一个 > ,当然,如果你不嫌麻烦,可以每行开头都加一个
链接和邮件地址
一个邮件地址链接: <example@example.com>
简单的行内链接 <http://chenluois.com>
效果:http://chenluois.com一个或者多个带标题的链接 [Resize](http://resizesafari.com "a Safari extension")
效果: Resize
引用类型的链接: [reference style][id]
这样点击reference style,就能跳转到标记为 id的地址 ,当然,你需要把这些信息写到你的文件里面:
[id]: http://www.baidu.com "baidu"
这个链接中的标题 (或者称为 工具提示 )是可选的
强制换行
用两个或者以上的空格结束一行(按空格键)会产生一个强制换行,就像HTML中的 <br/>
或者可以使用 controll+enter
附加的语法
脚注
脚注和引用型链接非常相似. 一个脚注由两个部分组成: 一个在文本上,将会变成一个描述数字的部分; 一个脚注定义;
这是一个带脚注的文本[^1]
效果:这是一个带脚注的文本1
删除线
两个波浪号包括的内容会添加删除线代码:```
Strikethrough```效果:Strikethrough
表格
一个简单的表格,看起来是这样的:
代码:```First Header | Second Header | Third Header------------ | ------------- | ------------Content Cell | Content Cell | Content CellContent Cell | Content Cell | Content Cell
效果:
First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell | Content Cell
Content Cell | Content Cell | Content Cell
如果你愿意,你可以在每行的开头和结尾加上管道符 `|`
| First Header | Second Header | Third Header || ------------ | ------------- | ------------ || Content Cell | Content Cell | Content Cell || Content Cell | Content Cell | Content Cell |```效果:
First Header | Second Header | Third Header |
---|---|---|
Content Cell | Content Cell | Content Cell |
Content Cell | Content Cell | Content Cell |
通过给分隔行添加冒号的方式,实现对表格内容的对齐代码:```
First Header | Second Header | Third Header:----------- | :-----------: | -----------:Left | Center | RightLeft | Center | Right```效果:
First Header | Second Header | Third Header |
---|---|---|
Left | Center | Right |
Left | Center | Right |
Mou 编辑器特有的指令
操作
- 复制HTML代码: Option + Cmd + C
- 加粗: 选择文本, Cmd + B
- 强调: 选择文本, Cmd + I
- 行内代码: Cmd + K
- 删除线: 选择文本, Cmd + U
- 链接: 选择文本, Control + Shift + L
- 图片: 选择文本, Control + Shift + I
- 选择单词: Control + Option + W
- 选择行: Shift + Cmd + L
- 全选: Cmd + A
- 反选: Cmd + D
- 转为大写: Select text, Control + U
- 转为小写: 选择文本, Control + Shift + U
- 转为首字母大写: 选择文本, Control + Option + U
- 转成列表: 选中行, Control + L
- 转成引用块: 选中行, Control + Q
- 转空格为Tab: Control + [
- 转Tab为空格: Control + ]
- 插入当前日期: Control + Shift + 1
- 插入当前时间: Control + Shift + 2
- 插入 <: Control + Shift + ,
- 插入 >: Control + Shift + .
- 插入 &: Control + Shift + 7
- 插入空格: Control + Shift + Space
- 左移选中行: 选中一行或者多行, Cmd + [
- 右移选中行: 选中一行或者多行, Cmd + ]
- 新建一行: Cmd + Return
- 注释: Cmd + /
- 换行: Control + Return
编辑
- 自动完成当前单词: Esc
- 查找: Cmd + F
- 关闭查找工具栏: Esc
导出
- 导出 HTML: Option + Cmd + E
- 导出 PDF: Option + Cmd + P
更多的用法,大家可以参考Markdown官方教程
-
这是脚注的定义↩