diff --git a/mdbook-pdf/README.md b/mdbook-pdf/README.md index f89069d4ada9ff40c4d69eeb339a98b7bf803bac..ed011f20b7340926ed47f830e70a33480e13fbee 100644 --- a/mdbook-pdf/README.md +++ b/mdbook-pdf/README.md @@ -22,10 +22,91 @@ title = "An Example" 最后,您可以使用 `mdbook build` 命令生成书籍并获取PDF文件,您的PDF文件将被存放在`book/pdf/output.put`。 +(注:因为注意到书名中很容易出现特殊字符,比如说`:`,这样的话会导致生成相关PDF文件失败,所以文件名没有使用`<书名>.pdf`这种的形式,而是统一用`output.pdf`) + ## 配置 支持自定义PDF纸张方向、页面缩放比例、纸张宽度和高度、页面边距、生成的PDF页面范围、是否显示页眉和页脚以及自定义其格式等。 -查看 [book.toml](test_doc/book.toml#L10-L33) 以了解 `[output.pdf]` 可用配置的详细信息。 +查看 [book.toml](test_doc/book.toml#L10-L33) 以了解 `[output.pdf]` 可用配置的格式。 + +### 具体参数详解 +- trying-times + +接受输入一个整型数,默认为`1`。其指定假如发生PDF生成失败的情况重试的次数。 + +- browser-binary-path + +接受输入一个字符串,默认为空`''`,程序自动判断路径。其指定浏览器可执行文件路径。 + +本程序支持最新的基于Chromium的浏览器,不支持Safari和Firefox。如果你需要指定,请指定完整的路径,比如说`/usr/bin/foo`。如果指定了错误的可执行文件,则很可能会出现超时错误或者直接报错。 + +- landscape + +接受输入一个布尔值,默认为`false`。其指定PDF纸张方向,`true`为横向,`false`为纵向。 + +- display-header-footer + +接受输入一个布尔值,默认为`false`。其指定是否显示页眉和页脚,`true`为显示,`false`为不显示。 + +- print-background + +接受输入一个布尔值,默认为`false`。其指定是否在PDF中显示背景图片,`true`为显示,`false`为不显示。 + +- scale + +接受输入一个数字,默认为`1`。其指定缩放因子,例如指定值为`1.25`,则将页面缩放125%。 + +- paper-width + +接受输入一个数字,默认为`8.5`。其指定页面宽度的英尺数,如果需要使用A4纸请将此值设为`8`。 + +- paper-height + +接受输入一个数字,默认为`11`。其指定页面高度的英尺数,如果需要使用A4纸请将此值设为`10`。 + +- margin-top + +接受输入一个数字,默认为`1`。其指定页面上边距的厘米数。 + +- margin-bottom + +接受输入一个数字,默认为`1`。其指定页面下边距的厘米数。 + +- margin-left + +接受输入一个数字,默认为`1`。其指定页面左边距的厘米数。 + +- margin-right + +接受输入一个数字,默认为`1`。其指定页面右边距的厘米数。 + +- page-range + +接受输入一个字符串,默认为空`''`,即不截取PDF页面。其指定生成PDF文件页面截取范围,支持指定常见打印机格式页面范围,如`'1-5, 8, 11-13'`则是将第1到5页以及第8页和第11到13页截取出来生成。 + +- ignore-invalid-page-ranges + +接受输入一个布尔值,默认为`false`。其指定,如果上面指定的PDF文件页面截取范围格式正确,但是实际无法按照语义执行,是否忽略。`true`为忽略,生成全部PDF页面,`false`为进行报错,如在指定`3-2`这种情况下将会报错,PDF生成失败。 + +- header-template + +接受输入一个字符串。其指定PDF文件页眉的HTML模板。其值应该是一个有效的HTML标记,并使用以下类从而将对应值插入其中: + + - date: 格式化后的PDF生成日期 + - title: 书的标题 + - url: PDF文件存放路径 + - pageNumber: 当前页号 + - totalPages: 总共页数 + +例如,`''` 将生成一个包含标题的页眉。 + +- footer-template + +接受输入一个字符串。其指定PDF文件页脚的HTML模板。其值的格式同header-template。 + +- prefer-css-page-size + +接受输入一个布尔值,默认为`false`。其指定是否使用 CSS 定义的页面大小。`true`为使用,`false`时页面将通过缩放来适应纸张大小。 ## 关于 [headless_chrome](headless_chrome)