PHPackages                             plhw/hf-bookdown-template - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. plhw/hf-bookdown-template

AbandonedArchivedLibrary

plhw/hf-bookdown-template
=========================

Bookdown Template

0.1.0(8y ago)0992[1 PRs](https://github.com/plhw/hf-bookdown-template/pulls)BSD-3-ClausePHP

Since Nov 15Pushed 3y agoCompare

[ Source](https://github.com/plhw/hf-bookdown-template)[ Packagist](https://packagist.org/packages/plhw/hf-bookdown-template)[ Docs](https://github.com/plhw/hf-bookdown-template)[ RSS](/packages/plhw-hf-bookdown-template/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (1)Versions (3)Used By (0)

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting
================================================================

[](#bookdownio-with-bootswatch-styles-and-prism-syntax-highlighting)

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

Installation
------------

[](#installation)

Installation of this library uses Composer. For Composer documentation, please refer to [getcomposer.org](http://getcomposer.org/).

Put the following into your `composer.json` or run `composer require tobiju/bookdown-bootswatch-templates`.

```
{
    "require-dev": {
        "tobiju/bookdown-bootswatch-templates": "^0.2.0"
    }
}

```

Put the following into your `bookdown.json`

```
{
    ...
    "template": "../vendor/tobiju/bookdown-bootswatch-templates/templates/main.php"
}

```

Styles
------

[](#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](https://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](http://prismjs.com/) / [prism-styles](https://github.com/PrismJS/prism-themes) 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
-------------

[](#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.

Generate Documentation
----------------------

[](#generate-documentation)

> Change the path to your bookdown.json file.

See the [documentation example](https://github.com/tobiju/bookdown-bootswatch-templates-example). It can be compiled using [bookdown](http://bookdown.io) and [Docker](https://www.docker.com/). The following example uses the [Docker Bookdown](https://hub.docker.com/r/sandrokeil/bookdown/) and you can use it also out of the box for your project.

The style is set by an environment `CSS_BOOTSWATCH` variable and the PRISM style by `CSS_PRISM`. Here is an example for the `superhero` style with the prism `coy` style.

```
$ 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
```

or for Bookdown via Composer.

```
$ 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/
```

Then browse to

Bookdown Bootswatch templates in action
---------------------------------------

[](#bookdown-bootswatch-templates-in-action)

Here are some documentation examples generated with this Bookdown.io template.

- [prooph components](http://getprooph.org/)
- [interop-config](http://sandrokeil.github.io/interop-config/)

Further Information
-------------------

[](#further-information)

- [Bookdown](https://github.com/bookdown/Bookdown.Bookdown)
- [Bootswatch](https://bootswatch.com/)
- [PrismJS](http://prismjs.com/)
- [Docker Bookdown image with these templates](https://hub.docker.com/r/sandrokeil/bookdown/)

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3102d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e42bb1eb4035d280d16210974fa60d0dbddeba8a061abec926e5e081d097231d?d=identicon)[bushbaby](/maintainers/bushbaby)

---

Top Contributors

[![basz](https://avatars.githubusercontent.com/u/143068?v=4)](https://github.com/basz "basz (1 commits)")

### Embed Badge

![Health badge](/badges/plhw-hf-bookdown-template/health.svg)

```
[![Health](https://phpackages.com/badges/plhw-hf-bookdown-template/health.svg)](https://phpackages.com/packages/plhw-hf-bookdown-template)
```

###  Alternatives

[tobiju/bookdown-bootswatch-templates

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

1619.6k1](/packages/tobiju-bookdown-bootswatch-templates)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)