prooph / bookdown-template
Bookdown.io 配合 Bootswatch 样式和 Prism 语法高亮
v0.3.0
2017-08-22 08:56 UTC
Requires
- bookdown/bookdown: 1.x-dev
README
如果您使用 bookdown 生成文档,并希望为代码块添加一些漂亮的样式和语法高亮,那么这个包就能帮到您:)
致谢
此模板基于 https://github.com/tobiju/bookdown-bootswatch-templates。
安装
此库的安装使用 Composer。有关 Composer 文档,请参阅 getcomposer.org。
将以下内容放入您的 composer.json
或运行 composer require prooph/bookdown-template
。
{
"require-dev": {
"prooph/bookdown-template": "^0.2.0"
}
}
将以下内容放入您的 bookdown.json
{
...
"template": "../vendor/prooph/bookdown-template/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
顶部菜单徽标
要添加单独的徽标而不是显示 主页,您可以设置环境变量 MENU_LOGO
,它必须是一个指向图像的绝对 URI。