https://github.com/datalayer/jupyter-viewer
🪐 👀 Serverless Jupyter Notebook viewer aka NbViewer in pure React.js.
https://github.com/datalayer/jupyter-viewer
jupyter notebook reactjs viewer
Last synced: about 1 year ago
JSON representation
🪐 👀 Serverless Jupyter Notebook viewer aka NbViewer in pure React.js.
- Host: GitHub
- URL: https://github.com/datalayer/jupyter-viewer
- Owner: datalayer
- License: bsd-3-clause
- Created: 2023-07-23T15:18:19.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T16:55:08.000Z (about 1 year ago)
- Last Synced: 2025-04-14T17:55:43.000Z (about 1 year ago)
- Topics: jupyter, notebook, reactjs, viewer
- Language: TypeScript
- Homepage: https://viewer.datalayer.tech
- Size: 235 KB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://datalayer.io)
[](https://github.com/sponsors/datalayer)
# 🪐 👀 Jupyter Viewer
> A revisited [NbViewer](https://nbviewer.org) as a modern Web application to view Jupyter notebooks.
[NbViewer](https://nbviewer.org) is built on top of the [GitHub nbviewer repository](https://github.com/jupyter/nbviewer) and has been useful for many data scientists since years.
Jupyter Viewer takes over the concept of easy visualisation and brings it to the Web application developers with React.js components to render Notebooks without any Kernel. It is also available as JupyterLab extension.
You can try on https://viewer.datalayer.tech.
The documentation lives on https://jupyter-viewer.datalayer.tech.
If needed, Users can connect the static view to a Kernel and make it executable.
## Usage
This repository packages the [Jupyter UI Viewer](https://jupyter-ui.datalayer.tech/docs/components/viewer) component as a JupyterLab extension. Install and launch with the following commands (you will need Python installed on your machine).
```bash
pip install jupyter_viewer
jupyter viewer
```
After launching, enjoy the 👀 views on http://localhost:8888/jupyter_viewer (served by Jupyter).
You can view a Notebook hosted on GitHub using the following pattern: `http://localhost:8888/github/{account}/{repo}/{branch}/{path}`
```bash
# For example...
open http://localhost:8888/jupyter_viewer/github/datalayer/examples/main/pytorch-gpu/pytorch-gpu-example.ipynb
```
## Develop
Develop the Web application.
```bash
yarn
yarn start
```
```bash
# Browse the Webpack server.
open http://localhost:3063
open http://localhost:3063/github/datalayer/examples/main/pytorch-gpu/pytorch-gpu-example.ipynb
```
Develop the Jupyter Server
```bash
pip install -e .[test]
jupyter viewer
```
Browse the Jupyter Server.
```bash
open http://localhost:8888/jupyter_viewer
open http://localhost:8888/jupyter_viewer/github/datalayer/examples/main/pytorch-gpu/pytorch-gpu-example.ipynb
```
Develop the JupyterLab extension.
```bash
pip install -e .[test]
jupyter labextension develop . --overwrite
jupyter labextension list
jupyter server extension list
yarn jupyterlab
```
```bash
# Browse JupyterLab.
open http://localhost:8888
```
## Publish
```bash
make publish
open https://viewer.datalayer.tech
open https://viewer.datalayer.tech/github/datalayer/examples/main/pytorch-gpu/pytorch-gpu-example.ipynb
```
## Releases
Jupyter Viewer is released as a python package in [PyPI](https://pypi.org/project/jupyter-viewer).