{"id":20340176,"url":"https://github.com/webengage/gitbook-plugin-webengage","last_synced_at":"2026-06-08T19:01:59.991Z","repository":{"id":82265125,"uuid":"50831210","full_name":"WebEngage/gitbook-plugin-webengage","owner":"WebEngage","description":"WebEngage Integration To Enable Reader Engagement and Analytics For GitBook","archived":false,"fork":false,"pushed_at":"2016-04-28T16:28:28.000Z","size":14,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-11T00:08:29.675Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebEngage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-02-01T10:08:27.000Z","updated_at":"2016-02-01T10:10:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"250cb3f9-6760-4f68-b89e-f546876e2b19","html_url":"https://github.com/WebEngage/gitbook-plugin-webengage","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fgitbook-plugin-webengage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fgitbook-plugin-webengage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fgitbook-plugin-webengage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebEngage%2Fgitbook-plugin-webengage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebEngage","download_url":"https://codeload.github.com/WebEngage/gitbook-plugin-webengage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241867649,"owners_count":20033815,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T21:20:06.514Z","updated_at":"2026-06-08T19:01:54.962Z","avatar_url":"https://github.com/WebEngage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"WebEngage Integration And Reader Analytics For GitBook\n==============\n\n## Installation\n\n**NPM**:\n\n```\n$ npm install gitbook-plugin-webengage\n```\n\n**gitbook-cli**:\n\n```\n$ gitbook install\n```\n\u003e Make sure you already have made reference to `webengage`-plugin inside your `book.json` `plugins` section. **Ex.:**  \n\n\u003e ```\"plugins\": [..., \"webengage\", ...],```\n\n## Usage\n\nUse within your book by making following entry in your `book.json`:\n\n```\n{\n    \"plugins\": [\"webengage\"]\n}\n```\n\nNow set the WebEngage configuration inside the **plugins configuration** in your `book.json` file: \n\n**Configuration Options:**\n\n1. **licenseCode**: Your license code as issued by WebEngage on signing-up. This is a **Required** setting, and cannot be ignored.\n\n2. **version**: WebEngage Widget Code version. **Optional** setting. Default is **5**.\n\n3. **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.\nThis is an **Optional** setting. Default is **false**. \n\n**Example configuration:**\n```\n{\n    \"plugins\": [\"webengage\"],\n    \"pluginsConfig\": {\n        \"webengage\": {\n            \"licenseCode\": \"~f42fg4h\",\n            \"version\": 5,\n            \"enableAnalytics\": true\n        }\n    }\n}\n```\n\nFor an overview of all available options for `JavaScript API's`, please refer to the official [WebEngage Docs](http://docs.webengage.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebengage%2Fgitbook-plugin-webengage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebengage%2Fgitbook-plugin-webengage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebengage%2Fgitbook-plugin-webengage/lists"}