HankelBao 2016-01-22
GitBook[1]是一个基于Node.js的命令行工具,可使用Github/Git和Markdown来制作精美的电子书,GitBook并非关于Git的教程。
GitBook支持输出多种文档格式:
·静态站点:GitBook默认输出该种格式,生成的静态站点可直接托管搭载GithubPages服务上;
·PDF:需要安装gitbook-pdf依赖;
·eBook:需要安装ebook-convert;
·单HTML网页:支持将内容输出为单页的HTML,不过一般用在将电子书格式转换为PDF或eBook的中间过程;
·JSON:一般用于电子书的调试或元数据提取。
使用GitBook制作电子书,必备两个文件:README.md和SUMMARY.md[2]。
Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。
用于编写说明文档,并且以“README.MD”的文件名保存在软件的目录下面。
Markdown指南
编辑
常用语法
最常见的Markdown格式选项和键盘快捷键[2]:
输出后的效果
Markdown
快捷键
Bold**text**Ctrl/⌘+B
Emphasize*text*Ctrl/⌘+I
Strike-through~~text~~Ctrl+Alt+U
Link[title](http://)Ctrl/⌘+K
InlineCode`code`Ctrl/⌘+Shift+K
Image![alt](http://)Ctrl/⌘+Shift+I
List*itemCtrl+L
Blockquote>quoteCtrl+Q
H1#Heading
H2##HeadingCtrl/⌘+H
H3###HeadingCtrl/⌘+H(x2)
标题
标题能显示出文章的结构。行首插入1-6个#,每增加一个#表示更深入层次的内容,对应到标题的深度由1-6阶。
●
H1:#Header1
●
H2:##Header2
●
H3:###Header3
●
H4:####Header4
●
H5:#####Header5
●
H6:######Header6
文本样式
●
链接:[Title](URL)
●
加粗:**Bold**
●
斜体字:*Italics*
●
删除线:~~text~~
●
高亮:==text==
●
段落:段落之间空一行
●
换行符:一行结束时输入两个空格
●
列表:*添加星号成为一个新的列表项。
●
引用:>引用内容
●
内嵌代码:`alert('HelloWorld');`
●
画水平线(HR):--------
图片
使用Markdown将图像插入文章,你需要在Markdown编辑器输入![]()。这时在预览面板中会自动创建一个图像上传框。你可以从电脑桌面拖放图片(.png,.gif,.jpg)到上传框,或者点击图片上传框使用标准的图像上传方式。如果你想通过链接插入网络上已经存在的图片,只要单击图片上传框的左下角的“链接”图标,这时就会呈现图像URL的输入框。想给图片添加一个标题,你需要做的是将标题文本插图中的方括号,e.g;![Thisisatitle]().
脚注
使用这样的占位符号可以将脚注添加到文本中:[^1].另外,你可以使用“n”而不是数字的[^n]所以你可以不必担心使用哪个号码。在您的文章的结尾,你可以如下图所示定义匹配的注脚,URL将变成链接:
[^1]:Thisismyfirstfootnote
[^n]:Visithttp://example.com
[^n]:Afinalfootnote
写代码
添加内嵌代码可以使用一对回勾号`alert('HelloWorld')`.对于插入代码,Ghost支持标准的Markdown代码和GitHubFlavoredMarkdown(GFM)[3]。标准Markdown基于缩进代码行或者4个空格位:
1
2
3
<header>
<h1>{{title}}</h1>
</header>
GFM使用三个回勾号```
1
2
3
4
5
´´´
<header>
<h1>{{title}}</h1>
</header>
´´´
例子
嵌入链接
1
Thisisaparagraphthatcontainsa[linktoexample]()
列表格式
1
2
3
4
5
6
7
Thisparagraphcontainsalistofitems.
*Item1
*Item2
*Itemthree
使用Markdown引用文本:
1
2
3
4
Thisparagraphhasaquote
>Thatispulledoutlikethis
fromthetextmypost.
编辑器
编辑
常用的Markdown编辑器
●
OSX
Byword
Mou
MacDown
●
Linux
ReText
UberWriter
●
Windows
MarkdownPad
Mou
●
iOS
Byword
●
浏览器插件
MaDo(Chrome)
●
高级应用
SublimeText2+MarkdownEditing/教程[1]