同步操作将从 Lyong/burr 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
burr 是一个电子书制作工具(命令行)。使用 Markdown 编写书籍内容,burr 可以将其转换成 PDF,ePub 和 Mobi 格式电子书。还能生成 HTML 格式,提供书籍在线阅读。
一份文稿,四种输出。
《Ruby on Rails 教程》这本书的电子书,以及在线阅读版就是使用 burr 制作的。
http://railstutorial-china.org
burr 只是一个 wrapper,电子书都是通过其他程序生成的。其中 PDF 使用 PrinceXML,ePub 使用 eeepub,mobi 使用 kindlegen。所以在使用 burr 之前,请确保安装了这些程序。具体的安装过程请参照相应程序的安装说明。
burr 是一个 Ruby gem,可以像其他 gem 一样安装。但是由于没有推送到 Rubygems.org,所以无法使用 gem install
命令安装。
在项目的 Gemfile
中加入以下代码:
gem 'burr'
然后执行 bundle
命令安装。
执行 burr new [path]
命令会生成一个新项目,生成的目录结构如下:
- Gemfile
- config.yml # 项目设置
- contents # 书稿文件夹
|- contents/chapter1.md
|- contents/chapter2.md
- outputs # 电子书输出文件夹
|- pdf/
|- style.css
|- site/
|- figures/ # 书中所用图片
|- style.css
|- epub/
|- mobi/
|- caches/ # 缓存文件夹,暂时未用
|- code/
$ burr export pdf
$ burr export epub
$ burr export mobi
$ burr export site
更多命令请执行 burr help
命令查看。
config.yml
中的设置,套用模板将 Markdown 转换成 HTML 文档;burr 使用 kramdown 的语法,并做了适当扩展。
A> #### 旁注标题
A>
A> 注意 > 符号后面要留一个空格。
A>
A> 如果旁注中有脚注,一定要写在旁注内。[^fn-1]
A>
A> [^fn-1]: 这是一个脚注。
W> #### 警告
W>
W> 这是一则警告:侵权必究!
T> #### 小贴士
T>
T> 夏天空调温度不要开的过低哟。
其他附加信息类型,请参考 Leanpub 的帮助文档。
kramdown 原生支持的代码块由 ~~~
分隔,但我更习惯使用 GitHub 的句法,所以 burr 提供了对后者的支持。除此之外,因为计算机书籍经常会为代码块加入说明及所在文件位置,所以 burr 利用 kramdown 的 Block Inline Attribute Lists 实现了这一功能,使用方法如下:
```ruby
def hello
puts "Hello, burr!"
end
```
{:caption="Ruby 方法定义示例" file="/path/to/file.rb"}
代码高亮通过 rouge 实现。
![alt text](path/to/image.jpg){:caption="示例图片"}
在 burr 开发中借鉴了 easybook 的很多思路,特此感谢。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。