Quick-start install and run Adds gitbook to packages.json so you don't have to explicitly install it. Integrates gitbook into npm to make it nice and fast to get started. `npm install` will install everything and set up gitbook; `npm run serve` and `npm run build` will run the equivalent gitbook commands. No need to worry about gitbook being on the path or being globally installed.
Also a couple of other tweaks to remove some npm and gitbook warning messages. Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/9fc94e08 Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/9fc94e08 Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/9fc94e08 Branch: refs/heads/master Commit: 9fc94e08417ab0a9ff75404a914f150bb051e39b Parents: 861762a Author: Richard Downer <[email protected]> Authored: Mon Oct 9 11:14:41 2017 +0100 Committer: Thomas Bouron <[email protected]> Committed: Mon Oct 16 14:55:35 2017 +0100 ---------------------------------------------------------------------- README.md | 27 + book.json | 3 +- package-lock.json | 4708 ++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 12 +- 4 files changed, 4747 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9fc94e08/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 5e560a0..440a163 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ Brooklyn Website and Docs Source ================================ +Quick start with the prototype GitBook documentation +---------------------------------------------------- + +On the first checkout, run: + +```bash +npm install +``` + +Then, to run a local webserver with the documentation: + +```bash +npm run serve +``` + +Wait for the message `Serving book on http://localhost:4000`, and then browse to +that URL to see the book. + +To build a static documentation website: + +```bash +npm run build +``` + +The generated files will be in `_book`. + + Contributor Workflow -------------------- http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/9fc94e08/book.json ---------------------------------------------------------------------- diff --git a/book.json b/book.json index 85f3bcc..ae08c30 100644 --- a/book.json +++ b/book.json @@ -1,4 +1,5 @@ { + "gitbook": "^3.2.3", "root": "./guide", "plugins" : ["include-highlight", "theme-api"], "pluginsConfig": { @@ -77,4 +78,4 @@ "brooklyn-version": "0.13.0-SNAPSHOT", "brooklyn-snapshot-git-branch": "master" } -} \ No newline at end of file +}
