包简介

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

README 文档

README

If you generate your documentation with bookdown and want some nice styles and syntax highlighting for your code blocks, then this package come to the rescue :).

Credits

This template is based on https://github.com/tobiju/bookdown-bootswatch-templates.

Installation

Installation of this library uses Composer. For Composer documentation, please refer to getcomposer.org.

Put the following into your composer.json or run composer require prooph/bookdown-template.

{
    "require-dev": {
        "prooph/bookdown-template": "^0.2.0"
    }
}

Put the following into your bookdown.json

{
    ...
    "template": "../vendor/prooph/bookdown-template/templates/main.php"
}

Styles

Choose your preferred style by setting the CSS_BOOTSWATCH and CSS_PRISM environment variable before generating the book. The default Bootswatch style is cerulean and for Prism ghcolors. See the example below how to use another style.

Visit bootswatch.com to see how the style looks like.

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

Visit prismjs.com / prism-styles to see how the Prism style looks like.

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

Top menu logo

To add an individual logo instead of displaying Home you can set the environment variable MENU_LOGO which must be an absolute URI to an image.

Further Information

prooph/bookdown-template 适用场景与选型建议

prooph/bookdown-template 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 36.06k 次下载、GitHub Stars 达 5，最近一次更新时间为 2016 年 12 月 15 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「markdown」「syntax」「docs」「docbook」「templates」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 prooph/bookdown-template 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 prooph/bookdown-template 我们能提供哪些服务？

定制开发 / 二次开发

基于 prooph/bookdown-template 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 prooph/bookdown-template 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

dg/texy 159

Texy converts plain text in easy to read Texy syntax into structurally valid (X)HTML. It supports adding of images, links, nested lists, tables and has full support for CSS. Texy supports hyphenation of long words (which reflects language rules), clickable emails and URL (emails are obfuscated again

bookdown/themes 11

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

code-orange/jot 7

Laravel package that generates RESTful API documentation in Markdown based on PHPDoc.

litalino/flarum-more-bbcode 2

Adds more BBCode

johnylemon/laravel-apidocs 46

Laravel API documentation generating tool

php-kit/html5-tools 0

A collection of libraries for working with HTML5 markup