No Description

Jason Grout a086d58aae Merge remote-tracking branch 'upstream/master' into notebook 9 years ago
examples a086d58aae Merge remote-tracking branch 'upstream/master' into notebook 9 years ago
scripts f12c67f7e5 Finish cleaning up build 9 years ago
src a086d58aae Merge remote-tracking branch 'upstream/master' into notebook 9 years ago
test 16fa9ab367 Clean up builds for better separation 9 years ago
typings 921a8db173 Update the es6 promises definitions to the official Typescript ones. 9 years ago
.gitignore 09f4ad52ba Add front matter 9 years ago
.travis.yml f5c235e696 Add a docs push token 9 years ago
CONTRIBUTING.md 09f4ad52ba Add front matter 9 years ago
LICENSE 09f4ad52ba Add front matter 9 years ago
README.md 15de67864d update readme 9 years ago
package.json a086d58aae Merge remote-tracking branch 'upstream/master' into notebook 9 years ago

README.md

Jupyter JS Plugins

Plugins for JupyterLab.

API Docs

Package Install

Prerequisites

npm install --save jupyter-js-plugins
conda install jupyter
pip install -U notebook  # requires the 4.1 version of the notebook

Source Build

Prerequisites

git clone https://github.com/jupyter/jupyter-js-plugins.git
cd jupyter-js-plugins
npm install
npm run build
conda install jupyter
pip install -U notebook  # requires the 4.1 version of the notebook

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

npm test

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

  • IE 11+
  • Firefox 32+
  • Chrome 38+

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.