gitbook-plugin-gitalks/package.json

gitalks is a gitbook comment plugin based on gitalk

{
  "name": "gitbook-plugin-gitalks",
  "main": "index.js",
  "version": "0.0.4",
  "description": "gitalks is a gitbook comment plugin based on gitalk",
  "engines": {
    "gitbook": ">=2.4.3"
  },
  "gitbook": {
    "properties": {
      "clientID": {
        "type": "string",
        "required": true,
        "description": "GitHub Application Client ID."
      },
      "clientSecret": {
        "type": "string",
        "required": true,
        "description": "GitHub Application Client Secret."
      },
      "repo": {
        "type": "string",
        "required": true,
        "description": "GitHub repository."
      },
      "owner": {
        "type": "string",
        "required": true,
        "description": "GitHub repository owner. Can be personal user or organization."
      },
      "admin": {
        "type": "array",
        "required": true,
        "description": "GitHub repository owner and collaborators. (Users who having write access to this repository)."
      },
      "number": {
        "type": "number",
        "default": -1,
        "description": "The issue ID of the page, if the number attribute is not defined, issue will be located using id."
      },
      "labels": {
        "type": "array",
        "default": [
          "Gitalk"
        ],
        "description": "GitHub issue labels."
      },
      "title": {
        "type": "string",
        "description": "GitHub issue title."
      },
      "body": {
        "type": "string",
        "description": "GitHub issue body."
      },
      "language": {
        "type": "string",
        "description": "Localization language key, en, zh-CN and zh-TW are currently available."
      },
      "perPage": {
        "type": "number",
        "default": 10,
        "description": "Pagination size, with maximum 100."
      },
      "distractionFreeMode": {
        "type": "boolean",
        "default": false,
        "description": "Facebook-like distraction free mode."
      },
      "pagerDirection": {
        "type": "string",
        "default": "last",
        "description": "Comment sorting direction, available values are last and first."
      },
      "createIssueManually": {
        "type": "boolean",
        "default": false,
        "description": "By default, Gitalk will create a corresponding github issue for your every single page automatically when the logined user is belong to the admin users. You can create it manually by setting this option to true."
      },
      "proxy": {
        "type": "string",
        "default": "https://cors-anywhere.herokuapp.com/https://github.com/login/oauth/access_token",
        "description": "GitHub oauth request reverse proxy for CORS. Why need this?"
      },
      "flipMoveOptions": {
        "type": "object",
        "description": "Comment list animation. Reference"
      },
      "enableHotKey": {
        "type": "boolean",
        "default": true,
        "description": "Enable hot key (cmd|ctrl + enter) submit comment."
      }
    }
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/xzghua/gitbook-plugin-gitalks.git"
  },
  "keywords": [
    "gitbook-plugin-gitalk",
    "gitalk",
    "gitment",
    "discuss",
    "comment",
    "issues",
    "github",
    "gitbook"
  ],
  "author": "xzghua",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/xzghua/gitbook-plugin-gitalks/issues"
  },
  "homepage": "https://github.com/xzghua/gitbook-plugin-gitalks#readme",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}