Git Product home page Git Product logo

node-gitbook-api's Introduction

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 details about an author

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

node-gitbook-api's People

Contributors

samypesse avatar paazmaya avatar gorbiz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.