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 :).

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 tobiju/bookdown-bootswatch-templates.

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

Put the following into your bookdown.json

{
    ...
    "template": "../vendor/tobiju/bookdown-bootswatch-templates/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.

Generate Documentation

Change the path to your bookdown.json file.

See the documentation example. It can be compiled using bookdown and Docker. The following example uses the Docker 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 http://localhost:8080/

Bookdown Bootswatch templates in action

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

• prooph components
• interop-config

Further Information

• Bookdown
• Bootswatch
• PrismJS
• Docker Bookdown image with these templates