bookdown - 撰写和发表自己的网络书籍/文档

BOOKDOWN官网 - bookdown上有不少人发布了自己的电子书

bookdown-demo (一个demo,github源码)- Rstudio出品,Yihui Xie开发,著名单细胞课程在用,y叔也在用 【强力推荐】

 

bookdown的优势

  • 完全开源,向收费说不
  • 完全自定义,想干啥就干啥
  • 有Rstudio背书,可以大胆的长期使用
  • 静态网站,很容易部署到Internet
  • 支持LaTeX,可以直接导出tex文档
  • 导出排版好的PDF文档和kindle文档
  • 使用十分方便,安装后可以专心使用RMarkdown写作
  • 写完后直接排序组合,一键build成书

R Markdown的优势(值得系统学习)

  • 代码与文本共存,程序员的最爱
  • 轻量级,再大的文件也有着极快的读取速度
  • 文末可以列出参考文献,科研狗的最爱

 

目前生信领域有两个用bookdown写得比较好的文档:

Analysis of single cell RNA-seq data - Hemberg / github

Data Integration, Manipulation and Visualization of Phylogenetic Trees - ggtree 

 

快速开始(里面有详细教程)

  • 完全开源,直接fork到自己的github(参考),然后git pull,写完直接push。
  • 不想开源,那就下载bookdown-demo,可以用Dropbox来进行跨平台的编辑。

安装bookdown的R包

install.packages("bookdown")  

用RStudio打开bookdown-demo.Rproj

打开R Markdown文件:index.Rmd,点击右侧的Build,生成初始的网页html文件,以及其他文件(PDF、epub,tex等)

 

撰写文档的基本逻辑

编写一个一个的Rmd文档,注意里面的标题要规范,最终书的标题就是从每一个Rmd文档中提取出来的。

修改 _bookdown.yml 文件,里面的 rmd_files: ["index.Rmd", "intro.Rmd"] 就是书籍的章节顺序,它会完全按顺序组合,一级标题就是一个章,二级标题就是章下面的一个小结,如此展开,Rmd的文件数量不限,最终只归总标题。

_bookdown.yml 文件里的 book_filename 是 PDF 文件的名字,index.Rmd 文件里的title才是真正的书名。

掌握了这些基本就可以开始写书了。

 

内容与形式彻底分离了,内容在Rmd里,以后不管bookdown这个包如何更新,都可以迅速完成网站的迁移。

 

使用细节

使用以下功能能让你的book更加专业,甚至能让你直接使用本工具来写毕业论文。

去掉一些不必要的花哨功能

去掉右侧的Facebook等链接,得改包。

优化搜索功能,搜索是确实烂,得改进包。

插入数学公式

插入代码

文内跳转

随时跳转到文档的任意一处,在标题后面添加 {#label} 来标记一个地方,然后用 \@ref(intro) 来构建跳转链接。

图像和表格也可以跳转,只不过在其表头要添加标记,跳转格式一样。

参考文献

参考文献稍微复杂些,需要在 book.bib 文件里手动输入参考文献。

我看有人用 betterbib,可以生成更为标准的参考文献。

注意:就算把文献添加到bib文件了,如果文中没有引用,那也还是不会出现在文中的。

建议使用 zotero-better-bibtex 插件,浏览文献官网,用插件导入文献zotero,然后到处LaTeX的参考格式,加到bib文件里即可。


可以接着谢益辉做的事:

搭建一个平台,构建合适的接口,让每个人都能开发自己的book;

主题,主题要能满足每个人的需求;

封面,自定义封面;

自定义功能;

优化搜索;

 

创建一个网站,能够自动读取github的Rmd文件,来生成一个html和pdf的书籍。 


RMarkdown的基本语法

基本的markdown语法

标题,一级二级三级等

有序无序列表

粗体斜体

专有引用

段落引用

分割线

插入链接

插入图片

插入表格

插入视频

插入代码

RMarkdown进阶语法

插入数学公式

插入跳转链接

插入参考文献

 

参考:

Markdown基本语法

 

posted @ 2019-08-14 14:10 Life·Intelligence 阅读(...) 评论(...) 编辑 收藏
TOP