https://github.com/swuecho/jupyerlite

https://github.com/swuecho/jupyerlite

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/swuecho/jupyerlite
• Owner: swuecho
• Created: 2021-07-14T04:03:01.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-14T04:05:42.000Z (almost 4 years ago)
• Last Synced: 2025-01-22T15:46:06.774Z (3 months ago)
• Language: Jupyter Notebook
• Size: 16.3 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# JupyterLite Demo

JupyterLite deployed as a static site to GitHub Pages, for demo purposes.

## ✨ Try it in your browser ✨

➡️ **https://jupyterlite.github.io/demo**

![github-pages](https://user-images.githubusercontent.com/591645/120649478-18258400-c47d-11eb-80e5-185e52ff2702.gif)

## Requirements

JupyterLite is being tested against modern web browsers:

- Firefox 90+

- Chromium 89+

## Usage

This repository is meant to demo how to deploy JupyterLite to GitHub Pages, using the released prebuilt JupyterLite assets.

To generate a new repository from this template, click on "Use this template":

![template](https://user-images.githubusercontent.com/591645/124951037-4285d680-e013-11eb-8965-05db03d5841f.png)

For more info, keep an eye on the JupyterLite documentation:

- Configuring: https://jupyterlite.readthedocs.io/en/latest/configuring.html

- Deploying: https://jupyterlite.readthedocs.io/en/latest/deploying.html

### Deploy a new version of JupyterLite

To deploy a new version of JupyterLite, you can update the version in https://github.com/jtpio/jupyterlite-demo/blob/main/requirements.txt.

The `requirements.txt` file can also be used to add extra JupyterLab extensions to the deployed JupyterLite website.

Then commit and push the changes. The site will be deployed on the next push to the `main` branch.

## Development

Create a new environment:

```bash

mamba create -n jupyterlite-demo

conda activate jupyterlite-demo

pip install -r requirements.txt

```

Then follow the steps documented in the [Configuring](https://jupyterlite.readthedocs.io/en/latest/configuring.html) section.