Skip to content

Commit 9cf9a24

Browse files
Update documentation around fullscreen usage of jupyterlite-sphinx apps (#253)
1 parent fb52264 commit 9cf9a24

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/full.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# Fullscreen access
22

3-
Once and JupyterLite example has been activate by a user, and "Open in Tab" button is available that will open the same
3+
Once a JupyterLite example gets activated by a user, an "Open in Tab" button becomes available, which will open the same
44
JupyterLite instance in a separate tab.
55

6-
## custom link to JupyterLite
6+
## Custom links to JupyterLite apps
77

8-
You can access the JupyterLite deployment that `jupyterlite-sphinx` made for you, in fullscreen, following the `./lite/lab` and `./lite/retro` relative urls:
8+
You can access the JupyterLite apps that `jupyterlite-sphinx` deployed for you, in fullscreen, using the following links:
99

10-
```{eval-rst}
10+
- [JupyterLab](lite/lab/index.html)
11+
- [Notebook](lite/tree/index.html)
12+
- [REPL](lite/repl/index.html)
13+
- [Voici](lite/voici/index.html)
1114

12-
- `JupyterLab <lite/lab/index.html>`_
13-
- `Notebook <lite/tree/index.html>`_
15+
## Tips for handling URLs
1416

15-
```
17+
If you want to open a specific notebook in fullscreen JupyterLab/Notebook/Voici, you can use the `path` URL parameter, e.g.
1618

17-
If you want to open a specific notebook in fullscreen JupyterLab/Notebook, you can use the `path` URL parameter, e.g. `./lite/lab/index.html?path=my_noteboook.ipynb`.
19+
- `./lite/lab/index.html?path=my_notebook.ipynb` for Lab
20+
- `./lite/notebooks/index.html?path=my_notebook.ipynb` for Notebook
21+
- `./lite/voici/render/my_notebook.html` for Voici
22+
23+
If you want to add code to the REPL for execution, you can use the `code` URL parameter, e.g. `./lite/repl/index.html?code=print("Hello, world!")`. You may also use `&execute=0` to prevent the code from being executed until you press Enter.
24+
25+
Info on more configuration options is available in the [REPL documentation](https://jupyterlite.readthedocs.io/en/stable/quickstart/embed-repl.html#configuration).
26+
27+
Please see the documentation for individual options for each directive and [global configuration options](configuration.md) for more information.

0 commit comments

Comments
 (0)