bookdown/themes

Bookdown.io 使用 Bootswatch 风格和 Prism 语法高亮

1.1.4 2018-08-10 15:21 UTC

This package is auto-updated.

Last update: 2024-09-11 04:54:58 UTC


README

此包现在属于 bookdown。您可以通过设置 bookdown.json 启用它。

{
"template": "bookdown/themes"
}

安装

只需安装 bookdown 并设置您的 bookdown.json

配置

目前,您可以通过以下设置在 bookdown.json 中配置 theme

"theme": {
    "toc": {
      "collapsibleFromLevel": 1
    }
  }

目录(toc)

样式

在生成书籍之前,通过设置环境变量 CSS_BOOTSWATCHCSS_PRISM 来选择您喜欢的样式。默认的 Bootswatch 风格是 cerulean,对于 Prism 是 ghcolors。请参阅以下示例了解如何使用其他样式。

访问 bootswatch.com 查看样式的外观。

  • cerulean
  • cosmo
  • cyborg
  • darkly
  • flatly
  • journal
  • lumen
  • paper
  • readable
  • sandstone
  • simplex
  • slate
  • spacelab
  • superhero
  • united
  • yeti

访问 prismjs.com / prism-styles 查看Prism样式的外观。

  • prism
  • dark
  • funky
  • okaidia
  • twilight
  • coy
  • atom-dark
  • base16-ateliersulphurpool.light
  • cb
  • ghcolors
  • hopscotch
  • pojoaque
  • xonokai

顶部菜单徽标

要添加单独的徽标而不是显示 主页,您可以设置环境变量 MENU_LOGO,它必须是一个指向图像的绝对 URI。

生成文档

更改您的 bookdown.json 文件路径。

请参阅文档示例。它可以使用 bookdownDocker 编译。以下示例使用 Docker Bookdown,您也可以将其用于您的项目。

样式由环境变量 CSS_BOOTSWATCH 设置,PRISM 样式由 CSS_PRISM 设置。以下是一个使用 superhero 样式和 prism coy 样式的示例。

$ docker run -it --rm -e CSS_BOOTSWATCH=superhero -e CSS_PRISM=coy -v $(pwd):/app sandrokeil/bookdown doc/bookdown.json
$ docker run -it --rm -p 8080:8080 -v $(pwd):/app php:5.6-cli php -S 0.0.0.0:8080 -t /app/doc/html

或者通过 Composer 安装 Bookdown。

$ export CSS_BOOTSWATCH=superhero && export CSS_PRISM=coy && php ./vendor/bin/bookdown doc/bookdown.json
$ php -S 0.0.0.0:8080 -t doc/html/

然后浏览到 http://localhost:8080/

Bookdown Bootswatch 模板应用示例

以下是一些使用此 Bookdown.io 模板生成的文档示例。

更多信息