No Description

Jason Grout 982c4a092f Merge pull request #1 from blink1073/pr/32 9 years ago
examples 66ca666ea9 Add title to example page 9 years ago
scripts b11935a496 Update readme and use conda version of notebook 9 years ago
src 74b9ed1fa7 Pass same defaults as existing 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 1e42444344 new filehandler 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 674ba15f32 Add example build instructions 9 years ago
package.json 33f75e0b40 Very basic execution of notebooks 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

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

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

npm test

Build Example

Follow the source build instructions first. Requires a Python install with the Jupyter notebook.

npm run build:example

Change to example directory and run python main.py.

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+

Bundle for the Browser

Follow the package install instructions first.

Any bundler that understands how to require() files with .js and .css extensions can be used with this package.

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.