prooph/bookdown-template

Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting

Maintainers

Details

github.com/prooph/bookdown-template

Homepage

Source

Issues

Installs: 19 486

Dependents: 21

Suggesters: 0

Security: 0

Stars: 4

Watchers: 5

Forks: 6

Open Issues: 0

v0.3.0 2017-08-22 08:56 UTC

Requires

BSD-3-Clause 18aa1e1af447832b3340daa3af63e3f8dabd606e

documentationmarkdownsyntaxdocsdocbooktemplateshighlightingstatic sitemanualbookdown

This package is auto-updated.

Last update: 2024-10-17 02:05:06 UTC

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