Skip to content

Commit d4acf55

Browse files
authored
Update README.md
1 parent e7fd4c1 commit d4acf55

File tree

1 file changed

+5
-62
lines changed

1 file changed

+5
-62
lines changed

README.md

Lines changed: 5 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -17,70 +17,13 @@ JupyterLite is being tested against modern web browsers:
1717
- Firefox 90+
1818
- Chromium 89+
1919

20-
## Usage
20+
## Deploy your JupyterLite website on GitHub Pages
2121

22-
This repository provides a demonstration of how to:
22+
Check out the guide on the JupyterLite documentation: https://jupyterlite.readthedocs.io/en/latest/quickstart/deploy.html
2323

24-
- build a JupyterLite release using prebuilt JupyterLite assets that bundles a collection of pre-existing Jupyter notebooks as part of the distribution;
25-
- deploy the release to GitHub Pages.
26-
27-
The process is automated using Github Actions.
28-
29-
You can use this repository in two main ways:
30-
31-
- generate a new repository from this template repository and build and deploy your own site to the corresponding Github Pages site;
32-
- build a release from a PR made to this repository and download the release from the created GitHub Actions artifact.
33-
34-
### Using Your Own Repository to Build a Release and Deploy it to Github Pages
35-
36-
*Requires Github account.*
37-
38-
Click on "Use this template" to generate a repository of your own from this template:
39-
40-
![template](https://user-images.githubusercontent.com/21197331/125816904-5768008a-77de-4cb3-8013-f3999b135c02.gif)
41-
42-
From the [*Actions*](./actions) tab on your repository, ensure that workflows are enabled. When you make a commit to the `main` branch, a Github Action will run to build your JupoyterLite release and deploy it to the repository's Github Pages site. By default, the Github Pages site will be found at `YOUR_GITHUB_USERNAME.github.io/YOUR_REPOSITORY-NAME`. *You can also check the URL from the Repository `Settings` tab `Pages` menu item.*
43-
44-
If the deployment failed, go to "Settings - Actions - General", in the "Workflow permissions" section, check "Read and write permissions". Update files such as readme, and commit so that GitHub rebuids and re-deploys the project. Go to "Settings - Pages", choose "gh-pages" as the source.
45-
46-
47-
__Add any additional requirements as required to the `requirements.txt` file.__
48-
49-
*You can do this via the Github website by selecting the `requirements.txt` file, clicking to edit it, making the required changes then saving ("committing") the result to the `main` branch of your repository.*
50-
51-
__Modify the contents of the `contents` folder to include the notebooks you want to distribute as part of your distribution.__
52-
53-
*You can do this by clicking on the `contents` directory and dragging notebooks from your desktop onto the contents listing. Wait for the files to be uploaded and then save them ("commit" them) to the `main` branch of the repository.*
54-
55-
Check that you have Github Pages enabled for your repository: from your repository [*Settings*](./settings) tab, select the [*Pages*](./settings/pages) menu item and ensure that the source is set to `gh-pages`.
56-
57-
When you commit a file, an updated release will be built and published on the Github Pages site. Note that it may take a few minutes for the Github Pages site to be updated. Do a hard refresh on your Github Pages site in your web browser to see the new release.
58-
59-
60-
61-
### Further Information and Updates
24+
## Further Information and Updates
6225

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

65-
- Configuring: https://jupyterlite.readthedocs.io/en/latest/configuring.html
66-
- Deploying: https://jupyterlite.readthedocs.io/en/latest/deploying.html
67-
68-
### Deploy a new version of JupyterLite
69-
70-
To change the version of the prebuilt JupyterLite assets, update the `jupyterlite` package version in the [requirements.txt](./blob/main/requirements.txt) file.
71-
72-
The `requirements.txt` file can also be used to add extra prebuilt ("federated") JupyterLab extensions to the deployed JupyterLite website.
73-
74-
Commit and push any changes. The site will be deployed on the next push to the `main` branch.
75-
76-
## Development
77-
78-
Create a new environment:
79-
80-
```bash
81-
mamba create -n jupyterlite-demo
82-
conda activate jupyterlite-demo
83-
pip install -r requirements.txt
84-
```
85-
86-
Then follow the steps documented in the [Configuring](https://jupyterlite.readthedocs.io/en/latest/configuring.html) section.
28+
- How-to Guides: https://jupyterlite.readthedocs.io/en/latest/howto/index.html
29+
- Reference: https://jupyterlite.readthedocs.io/en/latest/reference/index.html

0 commit comments

Comments
 (0)