R的bookdown扩展包(https://github.com/rstudio/bookdown) 是继knitr和rmarkdown扩展包之后， 另一个增强markdown格式的扩展， 使得Rmd格式可以支持公式、定理、图表自动编号和引用、链接， 文献引用和链接等适用于编写书籍的功能。 在bookdown的管理下一本书的内容可以分解成多个Rmd文件， 其中可以有可执行的R代码， R代码生成的文字结果、表格、图形可以自动插入到生成的内容中， 表格和图形可以是浮动排版的。 输出格式主要支持gitbook格式的网页图书， 这种图书在左侧显示目录， 右侧显示内容， 并可以自动链接到上一章和下一章； 通过单独安装的LaTeX编译器支持将书籍转换为一个PDF文件， 支持中文； 可以生成ePub等格式的电子书。

主要用于编写有多个章节的书籍， 也可以用来生成单一文件的研究报告。

建议使用RStudio集成环境制作这样的图书， 该软件内建了一键编译整本书的功能。 需要安装bookdown扩展包的最新版本。 bookdown扩展包现在还比较新， 还有一些BUG， 所以尽可能使用最新版的bookdown扩展包并且及时更新RStudio软件。 查看编译的网站建议使用Google Chrome浏览器， 此浏览器对gitbook的支持较好。

为了新写一本书或者从已有的书转换， 最简单的做法是从bookdown的网站下载bookdown配套的例书的zip文件 (见https://github.com/rstudio/bookdown-demo)， 将其解压到本地硬盘某个子目录， 然后修改其中的内容适应自己的书的需要。

因为中文需要一些特殊的设置， 以及在网络条件不好的条件下支持数学公式显示， 本书作者提供了一个粗浅的中文书bookdown模板， 下载链接为:

其中的CBook子目录包含了所需的中文书模板， CArticle子目录包含了论文格式模板， 其它子目录有一些别的模板， 为了在本地支持网页中的数学公式显示还有一个MathJax目录。 参见其中的readme.txt说明文件。

一本用bookdown管理的书， 一般放置在某个子目录下， 并作为一个RStudio项目(project)用RStudio管理。

也可以自己新建一个目录， 然后编辑生成必要的文件。 注意，所有的文本文件都要使用UTF-8编码。 一本bookdown书， 一般都需要有一个index.Rmd文件， 这是最后生成的网站的主页的原始文件， 可以在这个文件中写一些书的说明， 并在开头的YAML元数据部分进行有关设置， 如标题、作者、日期等。 index.Rmd的一个例子如下：

其中在三个减号组成的两行之间的内容叫做YAML元数据， 是一本书的设置， 上例中有书的标题、作者名、日期（用R程序自动生成）、描述。 其中的site选项很重要， 一定要有这个选项， site: bookdown::bookdown_site使得RStudio软件能辨认这是一个bookdown图书项目， 从而为其提供一键编译快捷方式。 元数据中output项指定默认的输出格式。 documentclass项为借助LaTeX编译PDF格式指定LaTeX的模板， 现在还不能支持ctexbook模板所以使用了book模板。 bibliography项指定一个或者几个.bib格式的文献数据库。

一个bookdown图书项目除了index.Rmd文件之外， 一般还应该有一个_bookdown.yml文件存放与整本书有关的YAML元数据。 例如

其中new_session: true设置很重要， 这使得每一个Rmd文件中的R程序都在一个单独的R会话中独立地运行， 避免了不同Rmd文件之间同名变量和同名标签的互相干扰。 book_filename是最终生成的LaTeX PDF图书或者ePub电子书的主文件名。 language下可以定制一些与章节名、定理名等有关的名称。

另外一个需要的设置文件是_output.yml文件， 用于输出格式的设置。 这部分内容也可以包含在index.Rmd的元数据中output条目下面。 内容如

其中的style.css是自定义的CSS显示格式， 可以去掉这一行，使用默认的CSS格式。 这个例子文件分为三部分， gitbook、pdf_book和epub_book三种输出格式分别设置了一些输出选项。 在gitbook部分， 设置了目录上方显示的书的主页的链接（before项）和目录下方显示的作者信息。 在in_header部分插入了一部分个性化的HTML代码， 这部分代码是使用本地的数学公式显示支持以免外网不通时数学公式不能显示， 插入的内容将出现在每个生成的HTML文件的head部分。

在pdf_book部分，设置了通过LaTeX编译整本书为PDF的一些选项。 指定了latex_engine为xelatex， 这对中文支持很重要。 in_header选项要求在LaTeX文件导言部分插入一个preamble.tex文件， 内容如：

其中很重要的是使用ctex包来支持中文。 在index.Rmd的元数据中也可以指定一些LaTeX选项， 比如指定页边距等（这些设置有些是非标准的，一般不需要）：

在bookdown项目中与index.Rmd同级的所有.Rmd文件都自动作为书的一章， 除非文件名以下划线开头。 这样做的好处是作者可以任意地增删章节， 编译整本书时章节编号会自动调整。 但是， 章节的顺序将按照文件名的字典序排列， 所以， 所有的包含一章内容的.Rmd文件， 最好命名为类似0201-rng.Rmd这样的名字， 文件名前面人为地加上排序用的序号， 使得章节按照自己的次序排列。 实际上， 也可以设置不自动将每个.Rmd文件都作为一章， 而是在_output.yml中设置一项rmd_files， 列出所有需要作为一章的文件，并以列出次序编译，如

这时，应该添加一个_site.yml文件，内容如：

除了index.Rmd文件， 项目中每个.Rmd文件都作为一章。 每个.Rmd文件第一行， 应该是以一个井号和空格开头的一级标题， 后面再加空格然后有大括号内以井号开头的章标签， 如

这些章标签去掉井号后会作为生成的HTML文件的名字， 所以一定要有章标签， 而且章节标签在全书中都不要重复以免冲突。 文件内可以用两个井号和一个空格开始的行表示节标题， 最后也应该有大括号内以井号开头的节标签，如

使用bookdown写书， 一般每章不要太长， 否则编译预览很慢， 读者浏览网页格式也慢。

内容相近的章节可以作为一个“部分”。 为此， 在一个部分的第一个章节文件的章标题前面增加一行， 以# (PART)开头， 以{-}结尾， 中间是部分的名称，如

书的最后可以有附录， 附录的章节将显示为A.1, B.1这样的格式。 为此， 在附录章节的第一个文件开头加如下的第一行标题行：

建议使用RStudio软件编辑内容， 管理和编译整本书。

在index.Rmd或者_bookdown.yml中设置site: bookdown::bookdown_site后， RStudio就能识别这个项目是一个bookdown项目， 这时RStudio会有一个Build窗格，其中有“Build book”快捷图标， 从下拉菜单中选择一个输出格式（包括gitbook、pdf_book、epub_book）， 就可以编译整本书。 对gitbook格式， 即HTML网页格式， 编译完成后会弹出一个预览窗口， 其中的“Open in Browser”按钮可以将内容在操作系统默认的网络浏览器中打开。

另一种办法是在命令窗口用如下命令编译（以输出gitbook为例）， 我个人认为这种办法更好用：

编译结果默认保存在_book子目录中， 可以在_bookdown.yml中设置output_dir项改为其它子目录。 编译整本书为pdf_book格式时，如果成功编译， 也会弹出一个PDF预览窗口。 可以在_book子目录中找到这个PDF文件。

将书编译为PDF需要利用LaTeX编译器， 这需要单独安装LaTeX编译软件， LaTeX编译器对输入要求十分严格， 一丁点儿错误都会造成整本书的编译失败， 所以对于不熟悉LaTeX的用户， 不建议使用bookdown的pdf_book输出格式。 当前的R Markdown仅支持谢益辉的TinyTeX软件， 安装和管理参见A.12.1。

对于较短的书， 做了一定修改后都可以重新编译gitbook结果和pdf_book结果。 在书比较长了以后， 每次编译都花费很长时间， 所以可以仅编译gitbook格式的一章， 修改满意后再编译整本书。 仅编译一章也需要所有的.Rmd文件都是已经编译过一遍的， 新增的Rmd文件会使得编译单章出错， 每次新增了Rmd文件都应该重新编译整本书， 但是内容修改后不必要重新编译整本书， 可以仅编译单章。

编译单章现在没有快捷图标， 只能在RStudio控制台（命令行）运行如下命令：

其中chap-name.Rmd是要编译的单章的文件名。 编译完成后在结果目录（默认是_book）中找到相应的HTML文件打开查看， 再次编译后仅需在浏览器中重新载入文件。 建议使用Google chrome浏览器， 用MS IE或者Edge浏览器对gitbook的Javascrpt支持不够好， 使得目录的层级管理、自动滚动、单章编译后的目录更新不正常， 而chrome则没有问题。

编译单章也不能解决所有的问题， 有些问题还是需要编译整本书， 而章节很多时整本书编译又太慢。 为此， 可以在项目中增加一个临时的部分内容子目录， 如testing子目录， 在子目录中存放相同的设置文件index.Rmd、_bookdown.yml、_output.yml， 以及图形文件、文献数据库文件， 并将要检查的若干章节复制到testing子目录中， 在testing中新建一个bookdown项目， 然后编译其中的整本书。 这在调试部分章节的HTML和PDF输出时很有效。 解决问题后只要将修改过的章节复制回原始的书的目录中。

有时仅仅想验证某个长数学公式或者表格， 用上述的编译单章或者单独一个小规模测试项目的办法也不经济。 这时，单独开一个备用的普通RStudio项目， 不能是bookdown项目， 在其中的Rmd文件中验证数学公式和表格的编排， 这样最为方便。

有时需要根据编译输出目标采用不同的设置， 比如， 输出为html时可以使用HTML插件(widgets)， 而输出到PDF则不可以。 可以用 knitr::opts_knit$get("rmarkdown.pandoc.to") 感知当前编译过程的目标， 对HTML类，输出为"html"， 对PDF，输出为"latex"。

在写作时，每个一级到三级标题都应该有自定义的标签， 格式是在标题行末尾空格后添加{#label}， 其中label是自己指定的标签， 使用英文、数字、减号， 不要使用中文， 而且整本书不要有重复的标签。 为避免不同章节使用了重复标签， 可以取label的前一部分为所在章节的文件名。

如果要引用某一章节， 有如下的做法：

有时需要在数学公式内部、图形的说明中引用定理编号、公式编号等， 这需要预先定义单独的文字性引用， 然后再使用该文字引用。 定义文字引用如：

可以在数学公式内部、图形说明的字符串内用(ref:mytextlabel)的格式调用上面定义的文字引用。 目前在数学公式内部使用有BUG。

通过R的knitr和rmarkdown扩展包以及pandoc软件， .Rmd格式文件已经支持数学公式， 见R Markdown说明。

在用$$符号在两端界定的公式后面， 可以用\tag{标号}命令增加人为的公式编号，如

结果显示为

\[ y = f(x) \tag{*} \]

要注意的是， 在$$界定的数学公式内用了aligned环境后， 仅能在\end{aligned}之后加\tag{标号}命令， 而不能写在aligned环境内。 这样， 多行的公式将不能为每行编号。

用\tag命令人为编号比较简单易用， 但是在有大量公式需要编号时就很不方便， 只要增加了一个公式就需要人为地重新编号并修改相应的引用。 bookdown包支持对公式自动编号， 并可以按公式标签引用公式， 引用带有超链接。

bookdown的自动编号对LaTeX的equation环境、align环境都可以使用， 而且不需要在两端用$$界定。 在公式的末尾或者一行公式的\\换行符之前， 写(\#eq:mylabel)， 其中mylabel是自己给公式的文字标签， 文字标签可以使用英文字母、数字、减号、下划线。 如

将会对两行公式自动编号。 引用公式时， 用如\@ref(eq:mylabel)，其中mylabel是公式的自定义标签， 编译后这样的引用会变成带有链接的圆括号内的编号。

公式编号在全书中都不要有冲突（不同的公式定义了相同的编号）。 一种办法是，自定义的公式标签的开头以章节文件名开头。

定理、引理、命题、例题等， 使用特殊的markdown代码格式， 以三个冒号开头， 以三个冒号结尾， 在开头的三个反单撇号后面空格后写{.theorem}表示定理。 在.theorem后面， 可以用空格分隔后写一个定理的自定义标签， 标签以#开头，由字母、数字、减号组成， #号作为标签的开头标志但不作为标签的一部分。 可以用name="定理名称"指定一个显示的定理名。

设某个定理的自定义标签是#mythlabel， 则可以用如\@ref(thm:mythlabel)引用此定理的编号， 编号是在每一章内从头编号的。 编号有自动生成的链接。

例如：

当定理或例子内有列表时， 一定注意列表前后要空行， 否则会导致嵌套错误。 这种错误在编译HTML时无法发现， 但是会造成结果莫名其妙地出错。

bookdown提供了证明环境， 但是不太实用。

对例题， 将theorem替换成example， 在引用时将thm替换成exm。 如：

定理类的段落包括如下的种类：

其中的显示名可以在_bookdown.yml的language的label属性中修改， 见B.2。

bookdown使用.bib格式的文献数据库， 关于.bib格式的文献数据库请参考LaTeX的有关说明。 在index.Rmd的YAML元数据部分或者_bookdown.yml中用bibliography可以设置使用的一个或者多个.bib格式的文献数据库文件。 设某篇文章的.bib索引键是Qin2007:comp， 用 @Qin2007:comp 可以引用此文献， 用[@Qin2007:comp] 可以生成带有括号的引用。

指定.bib文件时可以用相对路径， 如“../docs/mybib.bib”。 有多个文件时， 写在方括号[]中并用逗号分隔， 如bibliography: [mybib.bib, ../docs/refs.bib]。

为了使得产生的文献引用包括跳转超链接， 可以在index.Rmd的元数据部分添加link-citations: true设置。

为了生成某个R扩展包的.bib格式的引用， 可以用R程序制作，例如：

下面是一个样例.bib文件的内容（注意要用UTF-8编码保存）：

bookdown图书的插图有两种， 一种是已经保存为图形文件的， 主要是png、jpg和pdf图片； 另一种是文中的R代码生成的图形。

已经有图形文件的， 可以用markdown格式原来的插图方法， 见markdown格式介绍。 但是，这样做不能给图形自动编号， 另外因为制作图书是有网页和PDF书两种主要输出格式的， 原有的插图方式在这两种输出格式上有细微的不一致。 所以，最好是统一使用Rmd的插图方法。

Rmd的插图方法就是写一段R代码段来插图， 如果是用程序作图，则代码中写作图的代码； 如果是已有的图形文件， 可以在一个单独的R代码段中用类似下面的命令插图：

{r} knitr::include_graphics("figs/myfig01.png")

其中figs是存放图形文件的子目录名， myfig01.png是要插入的图形文件名。 这样， 如果同时还有myfig01.pdf的话， 则HTML输出使用png图片而PDF输出自动选用pdf文件。 另外， 插图的选项在代码段的选项中规定： 用代码段的fig.with和fig.height选项指定作图的宽和高（英寸）， 用out.width和out.height选项指定在输出中实际显示的宽和高， 实际显示的宽和高如果使用如"90%"这样的百分数单位则可以自动适应输出的大小。

为了使得插图可以自动编号并可以被引用， 为代码段指定标签并增加一个fig.cap="..."选项指定图形标题。 代码段的标签变成浮动图形的标签，如myfiglabel， 则为了引用这个图只要用\@ref(fig:myfiglabel)。 注意，在整本书中这些标签都不能重复， 否则编译LaTeX支持的PDF输出会失败。

有些插图会伴随很长的说明文字， 这可以用代码段的fig.cap=选项指定， 但是其中的Markdown特有的格式在转换LaTeX时不一定支持， 而且在代码段选项中写太长的文字说明也是的程序难以辨认。 所以， 可以使用文字引用的方式： 在单独的一段中， 用如下格式定义一段可引用的文字内容：

其中mylabel是自己定义的仅由英文大小写字母、数字和减号组成的引用标志符。在需要使用这段文字的位置，用(ref:mylabel)这种格式引用。 注意定义和引用都是用的(ref:mylabel)语法。

用R生成PDF格式的图形时， 需要指定中文作为family选项， 所以在每个源文件的开头应该加上如下的设置， 使得生成PDF图时中文能够正确显示：

其中include=FALSE表示要不显示代码段的代码， 有运行结果也不插入到输出结果中， 是否允许运行视缺省的eval=的值而定。

bookdown书的表格也有两种， 一种是原来markdown格式的表格， 最好仅使用管道表， 管道表对中文内容支持最好。 为了对这样的表格自动编号， 需要在表格的前面或者后面空开一行的位置， 写

其中mylabel是自定义的表格标签。 在引用这个表时用如 \@ref(tab:mylabel)。

另一种表格是R代码生成的表格， 主要使用knitr::kable()函数。 在knitr::kable()函数中用选项caption=指定表格的说明文字（标题）， 这时生成表格的R代码段的标签，如myfiglab， 就自动构成了表格的引用标签主干， 实际引用如 \@ref(tab:myfiglab)。

加选项digits， 可以指定小数点后的数字位数。 不同列使用不同位数时， 可以指定一个包含各列小数点后位数的向量。

为了适应较长的表， 可以在LaTeX的preamble.tex中引入longtable包， 并在knitr::kable()中加选项longtable=TRUE。

可以设置kable()显示缺失值的方式， 如；

则缺失值显示成空单元。 默认显示是NA。

如果要对表格进行更丰富的定制， 可以使用kableExtra包。

flextable和fluxtable支持较多的输出格式和常见表格功能。

还有许多扩展包，不一一列举。

bookdown在生成PDF时使用LaTeX软件， 所以PDF输出的数学公式的支持很好， 但是LaTeX编译器也很挑剔， 稍微一点错误也造成编译失败。 比如，在行内公式内部如果紧邻$符号有多余的空格， 如$ y $，编译PDF时会出错。

bookdown生成的gitbook格式的网页书籍， 在有数学公式时， 使用MathJax库在浏览器中显示数学公式。 MathJax是用于网络浏览器中显示数学公式的优秀的Javascript程序库， 可免费使用。 但是， 当数学公式中含有中文（用\text{}或\mbox{}命令）时， 数学公式可能会显示不正常。 另外，数学公式默认使用远程服务器上的MathJax程序库处理， 在网络不通畅时显示很慢或者无法显示。 bookdown中使用MathJax的版本2， 但MathJax已经升级到版本3， 版本3有很大改动， 暂时还应该使用版本2以避免冲突。

为了避免远程调用MathJax程序库的麻烦， 改为本地使用。 将MathJax安装在了书生成的网站主目录的上三层，用../../../MathJax/mathjax.js路径访问。 假设下载整个MathJax库后解压放在了书的网页文件所在子目录的上三层的位置。

增加设置文件_header.html：

如果希望用远程服务器上的MathJax，可以使用如下的mathjax-cdnjs.html设置文件：

为了调用这样的设置文件，在_output.yml设置文件中如下设置：

注意，MathJax要求先设置再调入。 由于浏览器对MathJax输出方式有记忆， 所以如果不能正常显示中文公式， 需要右键单击公式，选择“Math Settings—Math Renderer”中的“SVG”或者“HTML-CSS”。

Ed Berry在网上分享了用bookdown生成PDF学位论文的经验： https://eddjberry.netlify.com/post/writing-your-thesis-with-bookdown/ 。 Chester Ismay提供了一个R扩展包thesisdown， 见 https://github.com/ismayc/thesisdown， 例子见https://thesisdown.netlify.com/。

有数学公式时， 对行内公式边缘处多余的空格十分敏感， 所以行内公式边缘不要有空格。

如果已经有用LaTeX写的书， 要转换为bookdown的Rmd格式， 可以用RStudio的支持RegEx的替换模式，如

可以写一个函数对LaTeX文件进行转换生成Rmd文件， 再手工修改。函数如