Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WolframResearch/wolfram-notebook-embedder
JavaScript embedder for Wolfram Cloud notebooks
https://github.com/WolframResearch/wolfram-notebook-embedder
embeddings javascript notebook notebook-web wolfram-language wolfram-mathematica
Last synced: 12 days ago
JSON representation
JavaScript embedder for Wolfram Cloud notebooks
- Host: GitHub
- URL: https://github.com/WolframResearch/wolfram-notebook-embedder
- Owner: WolframResearch
- License: mit
- Created: 2019-09-12T18:33:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-08T09:47:48.000Z (about 3 years ago)
- Last Synced: 2024-10-01T20:41:43.019Z (about 1 month ago)
- Topics: embeddings, javascript, notebook, notebook-web, wolfram-language, wolfram-mathematica
- Language: JavaScript
- Homepage: https://wolfr.am/NotebookEmbedder
- Size: 4.89 MB
- Stars: 57
- Watchers: 19
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wolfram-language - wolfram-notebook-embedder
README
# wolfram-notebook-embedder
A library to embed [Wolfram Cloud](https://www.wolframcloud.com/) notebooks on websites. It does *not* use an ``, but renders a notebook directly into a given DOM node for a more seamless experience.
## Installation
If you are using a package manager such as [npm](https://www.npmjs.com/get-npm) or [Yarn](https://yarnpkg.com/en/), you can install this package from the npm repository:
npm install wolfram-notebook-embedder
and then import it in your JavaScript code like so:import * as WolframNotebookEmbedder from 'wolfram-notebook-embedder';
You can also import this library as a `` tag from a CDN:<script crossorigin src="https://unpkg.com/[email protected]/dist/wolfram-notebook-embedder.min.js">
and then use the global variable `WolframNotebookEmbedder`.## Usage & Documentation
* [**Getting Started**](./docs/GettingStarted.md)
* [Library Interface](./docs/LibraryInterface.md)
* [Notebook API](./docs/NotebookAPI.md)
* [Server-Side Rendering](./docs/ServerSideRendering.md)
* [Notebook Loading Phases](./docs/NotebookLoadingPhases.md)
* [Troubleshooting](./docs/Troubleshooting.md)## Examples
* [Basic Example](./examples/basic.html)
* [Manipulate Example](./examples/manipulate.html)
* [Dimensions Examples](./examples/dimensions.html)
* [Server-Side Rendering](./examples/ssr.html)## Browser Support
We support all modern browsers (the last two major versions of Chrome, Firefox, Edge, Safari). Internet Explorer is *not* supported anymore.
## Contributing
Everyone is welcome to contribute. Please read the [Contributing agreement](CONTRIBUTING.md) and the [Development guide](./docs/Development.md) for more information, including how to run the tests.
## Versioning
We use [semantic versioning](https://semver.org/) for this library and its API.
See the [changelog](CHANGELOG.md) for details about the changes in each release.
Each version of this library is compatible with a certain range of versions of the Wolfram Cloud. Currently, the requirement is Wolfram Cloud 1.50 or higher. We try hard not to make any backward-incompatible changes on the Wolfram Cloud side, which would require an update of this library to keep embeddings working.
| Library version | Minimum Wolfram Cloud version |
|-----------------|-------------------------------|
| 0.1.x | 1.50 |
| 0.2.x | 1.55 |
| 0.3.x | 1.59 |## License
This project is licensed under the [MIT license](./LICENSE).