用markdown做笔记,参考文档可以轻松上手。
用markdown做笔记
Markdown 跟 HTML 一样,是一种标签语言。但是 Markdown 语法特别简单,适合用来写书或者做笔记。
Mardown 语法不是浏览器能直接支持的,所以需要先把 Mardown 语法写成的内容,编译成 HTML ,才能美观的显示出来。Github 就提供了这个编译环境。
例如,创建一个 README.md ,后缀一定要 .md 不然无法编译成功。
学会了markdown语法,再保证系统上已经安装了 git ,就可以上手gitbook了。
安装gitbook
首先先全局安装gitbook-cli
npm i -g gitbook-cli
然后新建一个文件夹,进入到文件夹,进行初始化
mkdir gitbook-note
cd gitbook-note
gitbook init
可以参考gitbook官网进行安装。
这样就可以生成两个文件:
1、README.md,显示笔记首页内容
2、SUMMARY.md,里面写目录
启动一个服务器,就可以看到这个笔记了,运行在localhost:4000端口
gitbook serve