Skip to content

Commit d1d8d83

Browse files
committed
Fix broken links
Alphabetical ordering in main README
1 parent 82a8099 commit d1d8d83

File tree

8 files changed

+70
-94
lines changed

8 files changed

+70
-94
lines changed

README.md

Lines changed: 57 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,23 @@ You may find it easier to learn how to create extensions _by examples_, instead
5252

5353
Start with the [Hello World](hello-world) and then jump to the topic you are interested in.
5454

55-
- [Hello World](hello-world)
56-
- [Signals](signals)
57-
- [Datagrid](datagrid)
58-
- [Command Palette](command-palette)
5955
- [Commands](commands)
56+
- [Command Palette](command-palette)
57+
- [Context Menu](context-menu)
58+
- [Custom Log Console](custom-log-console)
59+
- [Datagrid](datagrid)
60+
- [Hello World](hello-world)
61+
- [Kernel Messaging](kernel-messaging)
62+
- [Kernel Output](kernel-output)
6063
- [Launcher](launcher)
64+
- [Log Messages](log-messages)
6165
- [Main Menu](main-menu)
66+
- [React Widget](react-widget)
67+
- [Server Hello World](server-extension)
6268
- [Settings](settings)
69+
- [Signals](signals)
6370
- [State](state)
64-
- [React Widget](react-widget)
6571
- [Widgets](widgets)
66-
- [Log Messages](log-messages)
67-
- [Custom Log Console](custom-log-console)
68-
- [Context Menu](context-menu)
69-
- [Kernel Output](kernel-output)
70-
- [Kernel Messaging](kernel-messaging)
71-
- [Server Hello World](server-extension)
7272

7373
You can expect from each example:
7474

@@ -81,131 +81,107 @@ We have structured the examples based on the [extension points](https://jupyterl
8181

8282
You are welcome to open any [issue](https://github.com/jupyterlab/extension-examples/issues) or [pull request](https://github.com/jupyterlab/extension-examples/pulls).
8383

84-
## Basic
84+
### [Commands](commands)
8585

86-
### [Hello World](hello-world)
86+
Extend the main app with a Command.
8787

88-
Set up the development environment and print to the console.
88+
[![Commmand example](commands/preview.png)](commands)
8989

90-
[![Hello World](hello-world/preview.png)](hello-world)
90+
### [Command Palette](command-palette)
9191

92-
### [Signals](signals)
92+
Register commands in the Command Palette.
9393

94-
Use Signals to allow Widgets communicate with each others.
94+
[![Commmand Palette](command-palette/preview.png)](command-palette)
9595

96-
[![Button with Signal](signals/preview.png)](signals)
96+
### [Context Menu](context-menu)
97+
98+
Add a new button to an existent context menu.
99+
100+
[![Context Menu](context-menu/preview.gif)](context-menu)
101+
102+
### [Custom Log Console](custom-log-console)
103+
104+
Create a new log console.
105+
106+
[![Custom Log Console](custom-log-console/preview.gif)](custom-log-console)
97107

98108
### [Datagrid](datagrid)
99109

100110
Display a Datagrid as a Lumino Widget.
101111

102112
[![Datagrid](datagrid/preview.png)](datagrid)
103113

104-
## Command Palette
114+
### [Hello World](hello-world)
105115

106-
### [Command Palette](command-palette)
116+
Set up the development environment and print to the console.
107117

108-
Register commands in the Command Palette.
118+
[![Hello World](hello-world/preview.png)](hello-world)
109119

110-
[![Commmand Palette](command-palette/preview.png)](command-palette)
120+
### [Kernel Messaging](kernel-messaging)
111121

112-
## Commands
122+
Interact with a kernel from an extension.
113123

114-
### [Commands](commands)
124+
[![Kernel Messages](kernel-messaging/preview.gif)](kernel-messaging)
115125

116-
Extend the main app with a Command.
126+
### [Kernel Output](kernel-output)
117127

118-
[![Commmand example](commands/preview.png)](commands)
128+
Render kernel messages in an OuputArea.
119129

120-
## Launcher
130+
[![OutputArea class](kernel-output/preview.gif)](kernel-output)
121131

122132
### [Launcher](launcher)
123133

124134
Start your extension from the Launcher.
125135

126136
[![Launcher](launcher/preview.gif)](launcher)
127137

128-
## Menus
138+
### [Log Messages](log-messages)
139+
140+
Send a log message to the log console.
141+
142+
[![Log Messages](log-messages/preview.gif)](log-messages)
129143

130144
### [Main Menu](main-menu)
131145

132146
Add a Menu to the main app.
133147

134148
[![Main Menu](main-menu/preview.png)](main-menu)
135149

136-
## Settings
137-
138-
### [Settings](settings)
139-
140-
Create and use new Settings for your extension.
141-
142-
[![Settings](settings/preview.gif)](settings)
143-
144-
## State
145-
146-
### [State](state)
147-
148-
Use State persistence in an extension.
149-
150-
[![State](state/preview.gif)](state)
151-
152-
## React
153-
154150
### [React Widget](react-widget)
155151

156152
Create a React.js Widget in JupyterLab.
157153

158154
[![react-widget](react-widget/preview.gif)](react-widget)
159155

160-
## Widget Tracker
161-
162-
### [Widgets](widgets)
163-
164-
Add a new Widget element to the main window.
165-
166-
[![Custom Tab](widgets/preview.png)](widgets)
167-
168-
## Log Console
169-
170-
### [Log Messages](log-messages)
171-
172-
Send a log message to the log console.
173-
174-
[![Log Messages](log-messages/preview.gif)](log-messages)
175-
176-
### [Custom Log Console](custom-log-console)
177-
178-
Create a new log console.
179-
180-
[![Custom Log Console](custom-log-console/custom-preview.gif)](custom-log-console)
156+
### [Server Hello World](server-extension)
181157

182-
## Context Menu
158+
Create a minimal extension with backend (i.e. server) and frontend parts.
183159

184-
### [Context Menu](context-menu)
160+
[![Server Hello World](server-extension/preview.png)](server-extension)
185161

186-
Add a new button to an existent context menu.
162+
### [Settings](settings)
187163

188-
[![Context Menu](context-menu/preview.gif)](context-menu)
164+
Create and use new Settings for your extension.
189165

190-
## Advanced
166+
[![Settings](settings/preview.gif)](settings)
191167

192-
### [Kernel Output](kernel-output)
168+
### [Signals](signals)
193169

194-
Render kernel messages in an OuputArea.
170+
Use Signals to allow Widgets communicate with each others.
195171

196-
[![OutputArea class](kernel-output/preview.gif)](kernel-output)
172+
[![Button with Signal](signals/preview.png)](signals)
197173

198-
### [Kernel Messaging](kernel-messaging)
174+
### [State](state)
199175

200-
Interact with a kernel from an extension.
176+
Use State persistence in an extension.
201177

202-
[![Kernel Messages](kernel-messaging/preview.gif)](kernel-messaging)
178+
[![State](state/preview.gif)](state)
203179

204-
### [Server Hello World](server-extension)
180+
### [Widgets](widgets)
205181

206-
Create a minimal extension with backend (i.e. server) and frontend parts.
182+
Add a new Widget element to the main window.
207183

208-
[![Server Hello World](server-extension/preview.png)](server-extension)
184+
[![Custom Tab](widgets/preview.png)](widgets)
209185

210186
## Prerequisites
211187

custom-log-console/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The default log console extension in JupyterLab obtains log outputs from the ker
1111
1. Obtain the current active notebook and send message to his `Logger` instance (see the [log message](https://github.com/jupyterlab/extension-examples/tree/master/log-messages) example).
1212
2. Create your custom log console (covered in this example).
1313

14-
> It is strongly recommended to read [commands](https://github.com/jupyterlab/extension-examples/tree/master/commands), [command-palette](https://github.com/jupyterlab/extension-examples/tree/master/command-palette), [main-menu](https://github.com/jupyterlab/extension-examples/tree/master/main-menu), [widget-tracker](https://github.com/jupyterlab/extension-examples/tree/master/widget-tracker) and [react-widget](https://github.com/jupyterlab/extension-examples/tree/master/react-widget) examples before diving into this one.
14+
> It is strongly recommended to read [commands](https://github.com/jupyterlab/extension-examples/tree/master/commands), [command-palette](https://github.com/jupyterlab/extension-examples/tree/master/command-palette), [main-menu](https://github.com/jupyterlab/extension-examples/tree/master/main-menu), [widgets](https://github.com/jupyterlab/extension-examples/tree/master/widgets) and [react-widget](https://github.com/jupyterlab/extension-examples/tree/master/react-widget) examples before diving into this one.
1515
1616
To implement this log console you need to install the following packages:
1717

hello-world/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,6 @@ and here is the [JupyterFrontEnd class documentation](https://jupyterlab.github.
262262
JupyterLab is built on top of three major concepts. It is advised to look through the corresponding
263263
examples in the following order:
264264

265-
- _command_: Function to be executed from UI elements. See the [commands example](../../commands)
266-
- _widget_: UI based brick. See the [widgets example](../../widgets)
265+
- _command_: Function to be executed from UI elements. See the [commands example](../commands)
266+
- _widget_: UI based brick. See the [widgets example](../widgets)
267267
- _signal_: Observer pattern between JupyterLab elements. See the [signals example](../signals)

kernel-messaging/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ provided directly by the JupyterLab application:
7373
const manager = app.serviceManager;
7474
```
7575

76-
With these lines, you can extend the panel widget from the [signal example](../../signals) to initialize a
76+
With these lines, you can extend the panel widget from the [signal example](../signals) to initialize a
7777
kernel. In addition, you will create a `KernelModel` class in it and
7878
overwrite the `dispose` and `onCloseRequest` methods of the `StackedPanel`
7979
([see the documentation](https://jupyterlab.github.io/lumino/widgets/classes/stackedpanel.html))
@@ -282,7 +282,7 @@ In the [Kernel Output](../kernel-output)
282282
example, you will explore how you can reuse some Jupyter components to have a nicer display for kernel messages.
283283

284284
This example uses React to define UI elements. You can
285-
learn more about React in JupyterLab in [that example](../../react-widget/README.md).
285+
learn more about React in JupyterLab in [that example](../react-widget/README.md).
286286

287287
The UI refresh is triggered by signal emitions. To know more about it,
288-
you can have a look at the [signal example](../../signals/README.md).
288+
you can have a look at the [signal example](../signals/README.md).

kernel-output/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ protected onCloseRequest(msg: Message): void {
118118

119119
## OutputArea and Model
120120

121-
The `SimplifiedOutputArea` class is a `Widget`, as described in the [widget example](../../widgets/README.md).
121+
The `SimplifiedOutputArea` class is a `Widget`, as described in the [widget example](../widgets/README.md).
122122
It has the ability to display the results of a notebook cell execution.
123123
You can instantiate it with a new `OutputAreaModel`; this class is containing
124124
the data to show:

server-extension/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
![server extension example](./preview.png)
66

7-
It is strongly recommended to read the [basic hello-world](../../hello-world)
7+
It is strongly recommended to read the [basic hello-world](../hello-world)
88
example before diving into this one.
99

1010
- [The template folder structure](#the-template-folder-structure)

signals/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Let's look at the implementations details.
6262

6363
Start with a file called `src/button.ts`.
6464

65-
NB: For a React widget, you can try the [React Widget example](./../../react-widget) for more details.
65+
NB: For a React widget, you can try the [React Widget example](../react-widget) for more details.
6666

6767
`button.ts` contains one class `ButtonWidget` that extends the
6868
`Widget` class provided by Lumino.

widgets/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ You can associate style properties to the custom CSS class in the file
9090
## Where to Go Next
9191

9292
This example uses a command to display the widget. Have a look a the
93-
[commands example](../../commands/README.md) for more information about it.
93+
[commands example](../commands/README.md) for more information about it.
9494

9595
The widget created in this example is simple. You will find more advanced
9696
widgets in the following examples:
9797

98-
- Widget showing a [Datagrid](../../datagrid/README.md)
99-
- Widget integrating [React components](../../react-widget/README.md)
100-
- Widget interacting with a [Kernel](../../kernel-messaging/README.md)
98+
- Widget showing a [Datagrid](../datagrid/README.md)
99+
- Widget integrating [React components](../react-widget/README.md)
100+
- Widget interacting with a [Kernel](../kernel-messaging/README.md)

0 commit comments

Comments
 (0)