gitbook 入门教程之前置知识

markdown 基本知识

markdown 是一种简化的 html 语法,相比于 txt 无格式文本更强大.

你可以用专门的软件去编辑 markdown 文件,就像需要使用软件编辑 txt 文件一样,当然也可以什么软件也不用,甚至直接在记事本或命令行书写,只不过这样的缺点就是无法实时预览输出效果,安全依赖个人经验和想象力了.

markdown 文件后缀名是.md,安装了相应插件的浏览器或专门软件能够看到输出效果.

标题

语法格式: # + 空格 + 文本

大多数markdown编辑器支持 h1~h6 级标题,而富文本编辑器一般仅支持到二级标题.

示例:

# 标题1
## 标题2

效果:

标题1

标题2

列表

列表包括有序列表,无序列表和任务列表,并支持列表嵌套.

大多数 markdown 编辑器和富文本编辑器均支持有序列表和无序列表,而任务列表和列表嵌套支持度就不是很好,存在平台兼容性问题.

有序列表

语法格式：数字 + . + 空格 + 文本

示例:

1. 有序列表1 
2. 有序列表2 
3. 有序列表3 

效果:

1. 有序列表1
2. 有序列表2
3. 有序列表3

无序列表

语法格式：- 或 * 或 + + 空格 + 文本

示例:

- 无序列表1 
* 无序列表2 
+ 无序列表3 

效果:

• 无序列表1
• 无序列表2
• 无序列表3

链接和图片

markdown 编辑器和富文本编辑器均支持链接和图片,值得注意的是有些平台限制或禁止外链.

链接

语法格式：[显示文本] + (链接地址)

示例:

[https://snowdreams1006.github.io](https://snowdreams1006.github.io/)

效果:

https://snowdreams1006.github.io

图片

语法格式：! + [图片标题] + (图片地址)

示例:

![雪之梦技术驿站的头像](https://avatars0.githubusercontent.com/u/23238267?s=400&u=c60a9628495b4bfb4c6ee1a7bba8e3a8d265ca96&v=4)

效果:

代码

代码分为单行代码和多行代码,其中多行代码也叫做代码块.

大多数 markdown 编辑器均支持代码,富文本编辑器支持度不一样,有的支持单行代码有的支持代码块.

单行代码

语法格式：` + 单行代码 + `

示例:

`code`

效果:

code

多行代码

语法格式：``` + 多行代码 + ```

示例:

<pre>

function fun(){
 echo "这是一句非常牛逼的代码";
}
fun();

</pre>

效果:

function fun(){
  echo "这是一句非常牛逼的代码";
}
fun();

这里的富文本支持语法指的是 markdown 渲染后的内容能否正常显示,并不是指 markdown语法本身能够正常渲染,更多详情请参考 markdown 快速入门

git 基本知识

git 是全世界最先进的分布式版本控制系统,帮助项目更好地进行管理,支持版本历史管理和多人写作管理等功能.

简单地说,可以理解为一种优雅的文档备份方式,支持云端备份,多人协作等特点.

初始化项目

语法格式: git init

适合从零开始的本地项目,初始化后的项目才是能够被 git 管理的项目.

示例:

git init

克隆项目

语法格式: git clone

适合已有远程项目需要下载到本地,作用是将远程项目克隆到本地,和 git init 实现类似的功能.

示例:

git clone [e-mail]:username/username.github.io.git

添加文件

语法格式: git add

将文件添加到暂存区,支持多次添加文件,相当于写入缓存区.

示例:

git add .

提交文件

语法格式: git commit

将暂存区内容提交到版本库,完成一次历史版本.

示例:

git commit -m "写入提交备注,简短说明下提交意图和目标"

推送文件

语法格式: git push

将本地版本库推送到远程版本库,相当于本地文件备份到云端服务器.

示例:

git push origin master

拉取文件

语法格式: git pull

将远程版本库拉取到本地版本库,相当于云端服务器文件恢复到本地.

示例:

git pull

查看状态

语法格式: git status

查看当前文件状态,包括文件被新增,被修改,被删除,未提交等等.

示例:

git status 

比较差异

语法格式: git diff

查看两个文件之间的具体差异

示例:

git diff 

历史日志

语法格式: git log

查看版本库的提交历史日志

示例:

git log

上述仅介绍了 git 的简单命令,实际使用情况远不止这些,更多详情请参考 git 入门教程