You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by m4...@apache.org on 2017/10/25 21:04:57 UTC

[12/50] [abbrv] brooklyn-docs git commit: Add PDF generation README note and npm script

Add PDF generation README note and npm script

Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/078b41bf
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/078b41bf
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/078b41bf

Branch: refs/heads/master
Commit: 078b41bf94cf056315382ce36db7e726d4ce58d6
Parents: c73f0bd
Author: Richard Downer <ri...@apache.org>
Authored: Tue Oct 10 15:20:01 2017 +0100
Committer: Thomas Bouron <th...@cloudsoftcorp.com>
Committed: Mon Oct 16 14:56:02 2017 +0100

----------------------------------------------------------------------
 README.md    | 5 +++++
 package.json | 3 ++-
 2 files changed, 7 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/078b41bf/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 440a163..a4de71c 100644
--- a/README.md
+++ b/README.md
@@ -27,6 +27,11 @@ npm run build
 
 The generated files will be in `_book`.
 
+**To generate PDF**, first follow [these instructions to install ebook-convert](https://toolchain.gitbook.com/ebook.html), then run:
+
+```bash
+npm run pdf
+```
 
 Contributor Workflow
 --------------------

http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/078b41bf/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 5c766d9..e2e2083 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,8 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "postinstall": "gitbook install",
     "build": "gitbook build",
-    "serve": "gitbook serve"
+    "serve": "gitbook serve",
+    "pdf": "gitbook pdf"
   },
   "author": "",
   "license": "Apache-2.0",