Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 1.66 KB

.gitbook.md

File metadata and controls

68 lines (36 loc) · 1.66 KB

Gitbook information

To install gitbook cli

npm install -g gitbook-cli

To install gitbook runtime

gitbook install

npm run gitbook:install

To serve gitbook documentation

gitbook serve --port 8989

npm run gitbook:serve

Generate PDF - option 1

Prerequisites

  1. Install Calibre: https://calibre-ebook.com/download

  2. npm install svgexport -g

  3. Pre-requisites for node-canvas: https://github.com/Automattic/node-canvas/wiki/_pages

  4. npm install canvas

  5. Run npm run gitbook:export:pdf

A file book.pdf will be generated in the root directory

Known Issues

  • npm install fails for the gitbook-pdf dependency. Here is a work-around: https://github.com/GitbookIO/gitbook-pdf/issues/23
  • removed "gitbook-pdf": "^0.0.2", as a dependency from package.json. Please manually install gitbook-pdf until the issue can be resolved
  • Export PDF does not contain a

Generate PDF - option 2

  1. Install Pandoc brew install pandoc

  2. Verify version pandoc --version requires to be vresion 2.0 or higher.

  3. install pdf engine brew install Caskroom/cask/wkhtmltopdf. Version 0.12.4 or higher.

  4. Acquaint yourself with Pandoc https://pandoc.org/MANUAL.pdf

    Also see https://github.com/mszep/pandoc_resume#requirements

  5. Run the following to generate the PDF using html5 output pandoc -t html5 -s {input} -o {output} --pdf-engine=wkhtmltopdf

    Replace {input} and {output} with the file names.

Docker

Build

docker build --no-cache -t mojaloop/mojaloop-business-docs .

Push

docker push mojaloop/mojaloop-business-docs

Run

docker run --rm -it --name mojadoc -p 8989:8989 mojaloop/mojaloop-business-docs