使用 Sigil 制作一本关于写出好代码的epub电子书

引子

之前写了一些关于如何写出好代码的文章，在随笔分类“代码修行”下。打算制作一本电子书，将其中的重要经验总结起来，也是对自己十年编程生涯的一个交代。

了解了下，Sigil 是一款简单易用的电子书制作软件，它可以基于组织好的 HTML 文件自动生成 epub 文件。打算使用 Sigil 来制作电子书。


素材准备

Sigil 是基于 HTML 的。因此，制作 Sigil 需要准备一些组织好的 HTML 文件。

现在我的技术写作基本上已经切换成写 Markdown 了。因此，就需要一个将 Markdown 转换成 HTML 文件的方法。


将Markdown转换成HTML文件

可以先创建一个 HTML 文件模板：


<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <link rel="stylesheet" href="../Styles/global.css" type="text/css"/>
  <title>多行代码糅合在一行</title>
</head>

<body>
  <h1>多行代码糅合在一行</h1>

  
</body>
</html>

这里需要把Markdown文件内容转换成 HTML 内容然后粘贴到 body 体里。

可以使用 “墨滴” 这个网站。我一般都是把 markdown 文档粘贴到这里，然后点击“复制公众号”，就能获取对应的 HTML 内容，粘贴到公众号内容区域 或者 上述 body 体里。


制作过程

步骤一：新建文件

打开 Sigil 软件，点击菜单“文件-新建”，以下是初始界面


步骤二：添加 HTML 文件

为了演示方便，我将之前一本电子书的文件直接添加过来。这一步需要平时多多积累素材。如果已经写过博客的话，就容易很多了。

下面是添加完成后的效果：

可以看到，文件的章节逻辑逻辑是混乱的，需要重新组织。


步骤三：组织 HTML 文件

通过章节来组织文件顺序。可以直接用鼠标拖动文件，移动到合适的位置。

此时，目录文件是空的，content.opf 与实际文件顺序是不一致的。


步骤四：生成目录

点击菜单“工具-生成目录”，选择 H1 层级，记得按照文件顺序及标题来生成目录。


步骤五：打开epub文件

制作到一定步骤，可以使用电子书软件打开 epub 文件查看效果，进行小幅调整。


查看 epub 文件

如果想要知道 epub 文件里有什么，可以直接将 epub 文件重命名为 zip， 然后解压即可知道。


问题及解决

代码的处理

不同电子书软件对同一段代码的展示是不一样的，这就跟浏览器展示前端界面一样，存在兼容性问题。有的比较简洁，有的比较丑陋。

有两种办法：

  • 使用上面的 “墨滴” 网站，将 Markdown 文档转换成 HTML 粘贴进去。 测试几种电子书软件 sigil、苹果图书、ebook-view, calibre 均能展示较好。

  • 将代码截图，使用图片展示。可能略微繁琐，但可以展示成 IDE 里的优美样式，不受兼容性影响。适合于只读不编辑的情形。比如谈论代码质量，观其形即可。


我的第一本电子书

链接:https://pan.baidu.com/s/1M8-AnI6Rkve4gSomgMVV4A?pwd=ao73

提取码:ao73

一年有效。


小结

制作出人生的第一本电子书！

又 Get 了一项新技能~~


posted @ 2022-08-07 00:18  琴水玉  阅读(2329)  评论(0)  编辑  收藏  举报