gitbook-commander

gitbook-commander

An alternative lightweight CLI for the awesome GitBook documentation generator that, unlike the official CLI, doesn't assume it is installed globally (and, to the contrary, is build specifically for being used in npm scripts) and does not install anything on its own behalf.

Installation and Usage

$ npm install --save-dev gitbook
$ npm install --save-dev gitbook-commander

After that, the gitbook-local command will be available for you to use from npm scripts in package.json or via npx.

For example, you may add this or something similar to your package.json:

{
  "scripts": {
    "build-docs": "gitbook-local build"
  }
}

and run

$ npm run build-docs

to build your documentation. GitBook stays isolated inside your node_modules 🎉

Contributing

Issues and PRs are welcome if you spot anything worth fixing! ❤️

This project uses Conventional Commits and the JavaScript code style covered by its own ESLint config (no textual description, sorry 😔, just follow the surrounding code and run the linter via npm run lint or as a part of the general testing process via npm test).

Please adhere to the Code of Conduct for all the interaction in this repo.

License

MIT

Changelog

1.1.0 (2017-06-23)

Features

• cli: add "--version" option (e7dc940)
• cli: bail out if gitbook not found (12bd3ae)
• cli: make help message more verbose (3fd588b)
• cli: recommend commands in case of a typo (b1c48fe)
• cli: report unknown commands and options (43b63c7)
• cli: show usage in help (d2a1729)

<a name="1.0.0"></a>