Ansible Role: GitBook

An Ansible role of Install gitbook for Ubuntu, Apline and macOS.

Current Version:

• node: 10.19.0
• npm: 6.13.4
• gitbook-cli: 2.3.2
• gitbook: 3.2.3

Requirements

1. Ansible v2.8.0: The npm module start support the unsafe_perm args from v2.8.

Role Variables

node_reversion: '10.19.0'

# If we want to use the specific version, we need setting the
# 'gitbook_switch_specific_version' variable to 'true'.
gitbook_switch_specific_version: False
gitbook_specific_version: 2.6.7

# Alpine Linux.
gitbook_necessary_apk_packages:
  - bash
  - build-base
  - curl
  - gcc
  - git
  - nodejs
  - nodejs-npm
  - rsync

# Debian / Ubuntu.
gitbook_necessary_apt_packages:
  - bash-completion
  - build-essential
  - curl
  - git
  - libnss3-dev
  - nodejs
  - npm
  - rsync
  - wget
  - xdg-utils
  - xz-utils

gitbook_apt_cache_valid_time: 3600

# macOS.
gitbook_necessary_brew_packages:
  - curl
  - git
  - node
  - npm

gitbook_npm_packages:
  - gitbook-cli
  - svgexport

# Reference:
#
# * Official: https://github.com/GitbookIO?utf8=%E2%9C%93&q=plugin&type=&language=
gitbook_plugins:
  - disqus
  - ga
  - github
  - page-toc-button

Dependencies

None.

Example Playbook

- hosts: all
  roles:
    - { role: chusiang.gitbook }

Docker Container

This repository contains Dockerized Ansible, published to the public Docker Hub via automated build mechanism.

Docker Hub: chusiang/gitbook

Images

• chusiang/gitbook:2.6 (Dockerfile)
• chusiang/gitbook:3.2, lastest (Dockerfile)
• chusiang/gitbook:ubuntu-14.04 (Dockerfile)

Usage

$ docker run -it -v /src/gitbook:/tmp/gitbook chusiang/gitbook:ubuntu14.04 bash
root@5438276a451d:/tmp# cd gitbook && gitbook build .
info: 9 plugins are installed
info: 6 explicitly listed
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 41 pages
info: found 57 asset files
info: >> generation finished with success in 8.5s !

License

Copyright (c) chusiang from 2016-2020 under the MIT license.