{"id":19501093,"url":"https://github.com/gitbookio/plugin","last_synced_at":"2025-10-15T23:24:32.144Z","repository":{"id":16193109,"uuid":"18939767","full_name":"GitbookIO/plugin","owner":"GitbookIO","description":"Sample plugin for GitBook","archived":false,"fork":false,"pushed_at":"2017-11-22T20:22:18.000Z","size":236,"stargazers_count":66,"open_issues_count":5,"forks_count":57,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-20T11:37:56.011Z","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":"barteksc/AndroidPdfViewer","license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GitbookIO.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}},"created_at":"2014-04-19T11:25:09.000Z","updated_at":"2024-03-27T02:52:47.000Z","dependencies_parsed_at":"2022-09-11T16:10:14.553Z","dependency_job_id":null,"html_url":"https://github.com/GitbookIO/plugin","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fplugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fplugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fplugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GitbookIO%2Fplugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GitbookIO","download_url":"https://codeload.github.com/GitbookIO/plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250912660,"owners_count":21506865,"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-10T22:11:09.654Z","updated_at":"2025-10-15T23:24:27.093Z","avatar_url":"https://github.com/GitbookIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"GitBook Sample Plugin\n==============\n\nThis is a model for GitBook plugins.\n\n## How GitBook plugin works?\n\nA plugin for GitBook is a node package that can be published on [NPM](http://www.npmjs.org). It has to follow the name convention: `gitbook-plugin-*name*`.\n\n### package.json\n\n#### name\n\nThe package name should begin with ```gitbook-plugin-```.\n\nExamples: `gitbook-plugin-mixpanel`, `gitbook-plugin-googleanalytics`.\n\n#### engine\n\nThe package.json should contain a `engine` field using [the standard norm](https://www.npmjs.org/doc/json.html#engines).\n\n```\n\"engines\": {\n    \"gitbook\": \"*\"\n}\n```\n\nFor example if you want your plugin to supports only GitBook version supperior to 0.3.1:\n\n```\n\"engines\": {\n    \"gitbook\": \"\u003e=0.3.1\"\n}\n```\n\n### entry point\n\nThe plugin entry point should return an object with some metadata.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Fplugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgitbookio%2Fplugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgitbookio%2Fplugin/lists"}