tobiju / bookdown-bootswatch-templates
Bookdown.io 与 Bootswatch 样式和 Prism 语法高亮
Requires
- bookdown/bookdown: 1.x-dev
This package is not auto-updated.
Last update: 2024-09-20 22:58:32 UTC
README
如果你使用 bookdown 生成文档，并且想要为你的代码块添加一些漂亮的样式和语法高亮，那么这个包就能帮到你 :)。
安装
此库的安装使用 Composer。有关 Composer 文档，请参阅 getcomposer.org。
将以下内容放入你的 composer.json 或运行 composer require tobiju/bookdown-bootswatch-templates。
{
"require-dev": {
"tobiju/bookdown-bootswatch-templates": "^1.1.0"
}
}
将以下内容放入你的 bookdown.json
{
...
"template": "../vendor/tobiju/bookdown-bootswatch-templates/templates/main.php"
}
样式
在生成书籍之前，通过设置环境变量 CSS_BOOTSWATCH 和 CSS_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
顶部菜单Logo
如果你想添加一个单独的Logo而不是显示 主页，你可以设置环境变量 MENU_LOGO，它必须是一个指向图片的绝对URI。
生成文档
更改你的 bookdown.json 文件路径。
查看 文档示例。它可以使用 bookdown 和 Docker 编译。以下示例使用的是 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/
然后浏览到 https://:8080/
Bookdown Bootswatch 模板在行动
以下是一些使用此 Bookdown.io 模板生成的文档示例。