Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation around fullscreen usage of jupyterlite-sphinx apps #253

Merged
merged 6 commits into from
Feb 12, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions docs/full.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
# Fullscreen access

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

## custom link to JupyterLite
## Custom links to JupyterLite apps

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

```{eval-rst}
- [JupyterLab](lite/lab/index.html)
- [Notebook](lite/tree/index.html)
- [REPL](lite/repl/index.html)
- [Voici](lite/voici/index.html)

- `JupyterLab <lite/lab/index.html>`_
- `Notebook <lite/tree/index.html>`_
## Tips for handling URLs

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

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`.
- `./lite/lab/index.html?path=my_notebook.ipynb` for Lab
- `./lite/notebooks/index.html?path=my_notebook.ipynb` for Notebook
- `./lite/voici/render/my_notebook.html` for Voici

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.

Info on more configuration options is available in the [REPL documentation](https://jupyterlite.readthedocs.io/en/stable/quickstart/embed-repl.html#configuration).

Please see the documentation for individual options for each directive and [global configuration options](configuration.md) for more information.
agriyakhetarpal marked this conversation as resolved.
Show resolved Hide resolved
Loading