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

Create a set of example notebooks #30

Closed
jtpio opened this issue Apr 10, 2021 · 2 comments · Fixed by #100
Closed

Create a set of example notebooks #30

jtpio opened this issue Apr 10, 2021 · 2 comments · Fixed by #100

Comments

@jtpio
Copy link
Member

jtpio commented Apr 10, 2021

These example notebooks could be added to the local storage by default (so available in the file browser on the first startup), and be used to quickly showcase a specific feature of a kernel or the language.

@jtpio
Copy link
Member Author

jtpio commented Apr 16, 2021

For now maybe the simplest would be to have:

  • a new examples-extension package, with a plugin that depends on the IContents service
  • a set of notebooks in packages/examples-extension/notebooks, as normal .ipynb files with the correct metadata already populated (so it starts the right kernel)
  • on build, notebooks are placed under app/examples/notebooks as-is
  • on plugin activation, @jupyterlite/examples fetch the examples and adds them to the local storage with contents.save()
  • to be less disruptive, they could even be placed under an examples/directory:

image

@bollwyvl
Copy link
Collaborator

bollwyvl commented Apr 16, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants