mdbook-epub 使用教程

mdbook-epub 使用教程

mdbook-epub An experimental mdbook backend for creating EPUB documents. 项目地址: https://gitcode.com/gh_mirrors/md/mdbook-epub

1. 项目目录结构及介绍

mdbook-epub 是一个用于将 mdbook 文档转换为 EPUB 格式的实验性后端。项目的主要目录结构如下：

• src/: 源代码目录，包含了项目的核心实现。
• tests/: 测试代码目录，包含了项目的单元测试和集成测试。
• .github/workflows/: GitHub Actions 工作流文件，用于自动化测试和构建等。
• Cargo.toml: Rust 项目配置文件，定义了项目依赖、构建设置等。
• Cargo.lock: 依赖锁定文件，记录了项目依赖的具体版本。
• LICENSE: 项目许可证文件，本项目采用 MPL-2.0 许可。
• README.md: 项目自述文件，介绍了项目的用途和基本使用方法。

2. 项目的启动文件介绍

项目的启动主要是通过 mdbook-epub 可执行文件来完成的。在项目的根目录下，可以通过以下命令安装依赖并构建项目：

cargo install mdbook-epub

安装完成后，可以通过以下命令来运行 mdbook-epub：

mdbook-epub ./path/to/book/dir

或者使用 --standalone 参数：

mdbook-epub --standalone ./path/to/book/dir

这将在指定目录下生成 EPUB 文件。

3. 项目的配置文件介绍

项目的配置主要通过 book.toml 文件进行。在 book.toml 文件中，你需要添加一个空的 output.epub 表来告诉 mdbook 使用 EPUB 后端。

以下是一个示例配置：

[book]
title = "mdBook Documentation"
description = "Create book from markdown files. Like Gitbook but implemented in Rust"
author = "Mathieu David"

[output.html]
mathjax-support = true

[output.epub]

此外，你还可以在 book.toml 中配置以下选项：

• additional-css: 一个包含 CSS 样式表路径的列表，用于定制 EPUB 文档的样式。
• use-default-css: 控制是否包含默认的样式表。
• cover-image: 电子书的封面图片文件路径。
• additional-resources: 一个包含要添加到 EPUB 中的资源文件路径的列表。
• no-section-label: 在目录列表中不前置章节编号。
• curly-quotes: 启用直引号到智能引号的转换。
• footnote-backrefs: 添加脚注定义的反向引用链接。
• epub-version: 指定要使用的 EPUB 版本。

通过配置这些选项，你可以定制化输出 EPUB 文档的外观和内容。

mdbook-epub An experimental mdbook backend for creating EPUB documents. 项目地址: https://gitcode.com/gh_mirrors/md/mdbook-epub