nbinteract

README

gitbook-plugin-nbinteract

This package contains the Gitbook plugin for nbinteract.

Usage

Add "nbinteract" to the plugins in your book.json:

{
  "plugins": ["nbinteract"],
  "pluginsConfig": {
    "nbinteract": {
      // Optional parameters. For example:
      //
      // "auto_run": false
    }
  }
}

Configure the plugin using the following parameters:

{
  "spec": {
    "type": "String",
    "description": [
      "Spec for the BinderHub image. Must be in the format ",
      "${username}/${repo}/${branch}. By default uses the nbinteract ",
      "image."
    ],
    "default": "SamLau95/nbinteract-image/master"
  },
  "provider": {
    "type": "String",
    "description": [
      "Provider for the BinderHub image. ",
      "By default uses Github."
    ],
    "default": "gh"
  },
  "auto_run": {
    "type": "bool",
    "description": [
      "If true (default), automatically starts kernel and runs code when ",
      "page with widgets is loaded. If false, will look for a DOM ",
      "element with id nbinteract and attach a click handler to run."
    ],
    "default": true
  }
}

Configuration

Setting Description Type Allowed values
auto_run Bool
-
baseUrl String
default = https://mybinder.org
-
provider String
default = gh
-
spec String
default = SamLau95/nbinteract-image/master
-

Plugin

Gitbook plugin for nbinteract

https://github.com/SamLau95/nb-interact#readme


Latest: 0.0.32

0.0.10, 0.0.11, 0.0.12, 0.0.13, 0.0.14, 0.0.15, 0.0.16, 0.0.17, 0.0.18, 0.0.19, 0.0.20, 0.0.21, 0.0.22, 0.0.23, 0.0.24, 0.0.25, 0.0.26, 0.0.27, 0.0.28, 0.0.29, 0.0.30, 0.0.31, 0.0.32,

Requirements

GitBook
0.0.25 >=2.0.0
0.0.32 >=3.0.0

Maintainers

Open on NPM