Skip to content

Commit 05f73dc

Browse files
committed
Update instructions in the README
1 parent 52e92ca commit 05f73dc

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

web/interactive_terminal/README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,34 @@
22

33
An interactive terminal to easily try `pandas` in the browser, powered by JupyterLite.
44

5+
![image](https://user-images.githubusercontent.com/591645/175000291-e8c69f6f-5f2c-48d7-817c-cff05ab2cde9.png)
6+
57
## Build
68

79
The interactive terminal is built with the `jupyterlite` CLI.
810

9-
In `web/interactive_terminal`, run:
11+
First make sure `jupyterlite` is installed:
12+
13+
```bash
14+
python -m pip install jupyterlite
15+
```
16+
17+
Then in `web/interactive_terminal`, run the following command:
1018

1119
```bash
12-
jupyter lite build --lite-dir web/interactive_terminal --output-dir web/build/lite
20+
jupyter lite build
1321
```
22+
23+
## Configuration
24+
25+
This folder contains configuration files for the interactive terminal powered by JupyterLite:
26+
27+
- `jupyter_lite_config.json`: build time configuration, used when building the assets with the `jupyter lite build` command
28+
- `jupyter-lite.json` run time configuration applied when launching the application in the browser
29+
30+
The interactive `pandas` terminal application enables a couple of optimizations to only include the `repl` app in the generated static assets.
31+
To learn more about it, check out the JupyterLite documentation:
32+
33+
- Optimizations: https://jupyterlite.readthedocs.io/en/latest/howto/configure/advanced/optimizations.html
34+
- JupyterLite schema: https://jupyterlite.readthedocs.io/en/latest/reference/schema-v0.html
35+
- CLI reference: https://jupyterlite.readthedocs.io/en/latest/reference/cli.html
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
{
22
"LiteBuildConfig": {
33
"apps": ["repl"],
4-
"no_unused_shared_packages": true
4+
"contents": ["content"],
5+
"no_unused_shared_packages": true,
6+
"output_dir": "../build/lite"
57
}
68
}
79

0 commit comments

Comments
 (0)