plhw / hf-bookdown-template

此包已被废弃且不再维护。未建议替代包。

Bookdown 模板

维护者

详细信息

github.com/plhw/hf-bookdown-template

主页

源代码

问题

安装: 990

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 0

开放问题: 1

0.1.0 2017-11-15 17:15 UTC

Requires

BSD-3-Clause 28cf149fa9c49996722a0e4603f02142ca576bb1

This package is auto-updated.

Last update: 2022-12-10 08:34:11 UTC

README

如果您使用bookdown生成文档，并希望为代码块添加一些漂亮的样式和语法高亮，那么这个包就能帮到您 :)

安装

此库的安装使用Composer。有关Composer文档，请参阅getcomposer.org。

将以下内容放入您的composer.json中或运行composer require tobiju/bookdown-bootswatch-templates。

{
    "require-dev": {
        "tobiju/bookdown-bootswatch-templates": "^0.2.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/

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

Bookdown Bootswatch模板实战

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

更多信息