You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs(hello-world README): made intro section more visible and expanded on it for clarity
* docs(hello-world README): moved image below TOC for clarity; elaborated alt text
* docs(hello-world README): labeled the TOC for clarity; changed some heading names for clarity
* docs(READMEs): clarify how the TL;DR and hello-world examples relate
Adds a section to the hello-world example, 'Modify the extension', to indicate where this example picks up after the TL;DR leaves off. Also adds steps to the TL;DR to clarify what the
code snippet is doing and to mention that more details are available in hello-world, including the information on the extension template.
* docs(hello-world README): adds --trust flag to copier command
fixes this error:--trustcopier copy/update
* docs(hello-world README): adds step to create yarn.lock file
matches updated steps in the main README.md. Fixes yarn error message
* docs(hello-world README): changed file name
the first command installs dependencies specified in pyproject.toml, instead of setup.py
Copy file name to clipboardExpand all lines: README.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,10 @@
46
46
47
47
The goal of this repository is to show how to develop extensions for [JupyterLab](https://github.com/jupyterlab/jupyterlab), presented as short tutorial series.
48
48
49
-
To get started:
49
+
**Quick start:**
50
+
- Install, build, and run the `hello-world` extension example in JupyterLab by copying the code below.
51
+
- This corresponds to the first three sections of the [hello-world extension tutorial](hello-world/README.md). Read these sections for additional details on what these commands are doing and how to use the JupyterLab extension template.
52
+
- Continue with the tutorial at the [Modify the extension](hello-world/README.md#modify-the-extension) section, if desired.
-[Overview of the hello-world extension code](#overview-of-the-hello-world-extension-code)
9
+
-[Build and installing the hello-world extension](#build-and-install-the-hello-world-extension)
10
+
-[Modify the extension](#modify-the-extension)
11
+
-[Where to go next](#where-to-go-next)
10
12
11
-
## The template folder structure
13
+

14
+
15
+
## The JupyterLab extension template
12
16
13
17
Writing a JupyterLab extension usually starts from a configurable template. It
14
18
can be downloaded with the [`copier`](https://copier.readthedocs.io/) tool and the following command:
@@ -17,7 +21,7 @@ can be downloaded with the [`copier`](https://copier.readthedocs.io/) tool and t
0 commit comments