gitbook-api

node-gitbook-api

This is a javascript/node client library for the GitBook (https://www.gitbook.com) API.

This API is promise-based.

Installation

$ npm install gitbook-api

Examples

Create a client

var GitBook = require("gitbook-api");
var client = new GitBook();

Create an API client with an authentified user:

var client = new GitBook({
    username: "MyUsername",
    token: "password or token"
});

To use this api client with a GitBook Enterprise instance, simply add a host option, example: "host": "http://gitbook.mycompany.com".

List books

List books fron the authenticated user:

client.books()
.then(function(result) {
    // result.list: list of books
    // result.total: total count of books
}, function(err) {
    // Error occured
});

List all public books:

client.books('all')

Use pagination:

client.books({ skip: 50, limit: 100 })
client.books('all', { skip: 50, limit: 100 })

Get a specific book

client.book("GitBookIO/javascript").then(function(book) { });

Get detils about an author

client.author("GitBookIO").then(function(org) { });