Giter Club home page Giter Club logo

gitbook-plugin-webengage's Introduction

WebEngage Integration And Reader Analytics For GitBook

Installation

NPM:

$ npm install gitbook-plugin-webengage

gitbook-cli:

$ gitbook install

Make sure you already have made reference to webengage-plugin inside your book.json plugins section. Ex.:

"plugins": [..., "webengage", ...],

Usage

Use within your book by making following entry in your book.json:

{
    "plugins": ["webengage"]
}

Now set the WebEngage configuration inside the plugins configuration in your book.json file:

Configuration Options:

  1. licenseCode: Your license code as issued by WebEngage on signing-up. This is a Required setting, and cannot be ignored.

  2. version: WebEngage Widget Code version. Optional setting. Default is 5.

  3. enableAnalytics: Set this to true if you want to enable Reader-Analytics. This will allow you to analyse how your readers read your books/documentation, and which parts of the book/doc. needs more focus. This is an Optional setting. Default is false.

Example configuration:

{
    "plugins": ["webengage"],
    "pluginsConfig": {
        "webengage": {
            "licenseCode": "~f42fg4h",
            "version": 5,
            "enableAnalytics": true
        }
    }
}

For an overview of all available options for JavaScript API's, please refer to the official WebEngage Docs.

gitbook-plugin-webengage's People

Contributors

nitinbansal85 avatar jpreynat avatar

Watchers

James Cloos avatar  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.