Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.33 KB

index.md

File metadata and controls

40 lines (26 loc) · 2.33 KB
Raw

thebe

Thebe[core] Logo

A typescript library for web based interactive computing with Jupyter backends.

Want to add `thebe` with `jupyterlite` to your static website? See [Lite Quick Start](quickstart-lite.md).

The version of `thebe` and it's sub-packages documented here are currently in a release candidate phase `(0.9.0-rc.x)`.

For documentation on the current release version of `thebe` (tagged as `latest` on npm) see the [Thebe Documentation on Read the Docs](https://thebe.readthedocs.io/en/latest/).

The thebe packages

The thebe library is published as a collection of sub-packages on npm.

the thebe packages

  • The thebe package turns html tags with code into executable and editable cells that can be run interactively using a connection to a Jupyter kernel. It uses thebe-core internally.
  • thebe-core provides a typescript class API for handling connections, notebooks, cells, events and more.
  • thebe-lite is a drop in library that provides the Jupyterlite server for in-browser computation.
  • thebe-react a library of React Providers and Hooks for getting started with thebe in React.

What to use when

thebe : Use when you have a static HTML website or a framework where you can add scripts to load the javascript bundle and set configuraton options easily. You're happy with loading codemirror to make all selected <pre> tags into editors and the default thebe UI. See quickstart or using thebe.

thebe-core : Use when you are adding jupyter based computation into a typescript application, when you want Jupyter outputs on your webpage but you don't want to show all the code or when you want thebe-like behaviour, but want to complete control over the UI and kernel connections. See using thebe-core.

thebe-lite : Add this library alongside any other sub-package when you want to enable in-browser computation with the useJupyterLite option. See using thebe-lite.

thebe-react : Use if you are developing with the React or Remix frameworks. Other frameworks that leverage React may also work with the components provided in this library but are not tested. See using thebe-react.