跳转到主要内容

将markdown文件转换为电子书(EPUB或PDF)

项目描述

需求

请注意,您需要安装Calibre或Pandoc(或两者),才能生成EPUB文件,但您需要Calibre(及其CLI工具)来检查EPUB的兼容性。

安装

安装非Python需求后,您可以在系统范围内安装,或在内置的virtualenv中安装

pip install -e ./

用法

要开始一本新书,只需使用以下命令创建一个新的项目

md2ebook start

或者,也可以

md2ebook start directory-name

完成后,您可以进入此目录并使用build命令

md2ebook build

这将根据在book.json文件中定义的,构建您的书籍的HTML和EPUB版本。

额外命令

您可以使用以下命令检查您的EPUB完整性

md2ebook check

选项

有关md2ebook命令的更多信息,只需键入

md2ebook --help

您将获得关于命令及其选项的详细文档。

封面

您可以使用以下三种方式之一为您的电子书指定封面

  • --cover参数添加到命令行中

  • cover键添加到您的配置文件中

  • 在项目的根目录中留下一个cover.(png|jpg|jpeg|svg)文件,这个文件将被用作封面

如果以上任何一种都没有指向一个存在的文件,将使用丑陋的默认封面

请注意,配置选项或可选参数可以是URL(是的,类似于http://example.com/beautiful-cover.jpg)。

配置文件

在您的书籍目录根目录下,有一个 book.json 文件,其中包含您的书籍配置。此文件是必需的。

以下是它的 必需 选项,以下是一个完整的示例

{
    "files": ["chapter1.md", "chapter2.md", "chapter3.md"],
    "author": "Joe A. Nonymous",
    "title": "What a beautiful title",
    "fileroot": "what-a-beautiful-title",
    "generator": "calibre"
}
  • files 是一个包含在您的书籍根目录下的 markdown 文件列表。它们将按照该顺序处理并编译成单个电子书。

  • author 是书籍的作者姓名。

  • title 是书籍的标题,包含其全名。

  • fileroot 此字符串将作为不同输出的 根目录。按照示例,您将在书籍根目录下生成 what-a-beautiful-title.htmlwhat-a-beautiful-title.epub

  • generator 是“calibre”或“pandoc”。选择您喜欢的(或系统上可用的)。

额外配置

  • pdf:当使用 build 时触发 PDF 生成。将其设置为 truefalse。如果未设置,则不会生成 PDF。使用 --with-pdf 选项来覆盖此设置。

  • cover:将设置封面路径。这必须指向一个现有文件,如果可能的话,一个图像(png、jpg、jpeg 或甚至 SVG)。

  • extensions:此字符串列表定义了您可以添加到解析 Markdown 文件的 Markdown 扩展。请参考 Markdown 扩展以了解支持的扩展。

关于 Markdown 扩展的说明

以下是可以用的扩展列表

  • 额外(“extra”)

    • 缩写: (“abbr”)

    • 属性列表: (“attr_list”)

    • 定义列表: (“def_list”)

    • 带围栏的代码块: (“fenced_code”)

    • 脚注: (“footnotes”)

    • 表格: (“tables”)

    • 智能加粗: (“smart_strong”)

  • 警告: (“admonition”)

  • 代码高亮: (“codehilite”)

  • 标题 ID: (“headerid”)

  • 元数据: (“meta”)

  • 换行符转换为换行: (“nl2br”)

  • 合理的列表: (“sane_lists”)

  • 目录: (“toc”)

  • 维基链接: (“wikilinks”)

以下是一个使用扩展的 config.json 示例

{
"files": [
    "book.md"
],
"title": "Les 3 Mousquetaires",
"fileroot": "les-3-mousquetaires",
"author": "Alexandre Dumas",
"extensions": ["admonitions", "toc", "footnotes"],
"generator": "pandoc"
}

扩展参数的设置如文档中所述

"extensions": ["headerid(level=3)"]

致谢

此软件是 Copyleft 2013 - Bruno Bord。

它根据 MIT 许可证发布,有关更多详细信息,请参阅 LICENSE 文件。

项目详情


下载文件

下载适用于您平台的应用程序。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分发

md2ebook-0.1.1.tar.gz (8.7 kB 查看哈希值)

上传时间 源代码

支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面