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
Copy file name to clipboardExpand all lines: README.md
+26-12Lines changed: 26 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -52,26 +52,22 @@ as example for creating a customized toolkit.
52
52
The UI Toolkit is currently in a proof of concept. Track progress towards 1.0 [here](https://github.com/jupyterlab-contrib/jupyter-ui-toolkit/issues?q=is%3Aopen+is%3Aissue+milestone%3Av1.0).
53
53
Styles and API are not guarantee between minor versions prior to v1.0.0.
54
54
55
-
## Getting started
55
+
## Installation
56
56
57
57
### From NPM
58
58
59
-
You will need to install `yarn` (for example with `npm install --global yarn`).
60
-
61
-
To build the components packages, execute:
59
+
To install the `web-components` library, use either `npm` or `yarn` as follows:
Then to interactively test or develop web components:
69
-
70
-
```sh
71
-
cd packages/components
72
-
yarn start
65
+
```shell
66
+
yarn add @jupyter-notebook/web-components
73
67
```
74
68
69
+
> If you need the React components of the toolkit, you need to install `@jupyter-notebook/react-components`.
70
+
75
71
### From CDN
76
72
77
73
A pre-bundled script that contains all APIs needed to use Jupyter UI Toolkit is available on CDN. You can use this script by adding [`type="module"`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) to the script element and then importing from the CDN.
@@ -88,6 +84,24 @@ A pre-bundled script that contains all APIs needed to use Jupyter UI Toolkit is
88
84
89
85
The above CDN location points to the latest release of `@jupyter-notebook/web-components`. It is advised that when you deploy your site or app, you import the specific version you have developed and tested with.
90
86
87
+
## Contributing
88
+
89
+
You will need to install `yarn` (for example with `npm install --global yarn`).
90
+
91
+
To build the components packages, execute:
92
+
93
+
```sh
94
+
yarn install
95
+
yarn build
96
+
```
97
+
98
+
Then to interactively test or develop web components:
99
+
100
+
```sh
101
+
cd packages/components
102
+
yarn start
103
+
```
104
+
91
105
### JupyterLab demo extension
92
106
93
107
To test locally the JupyterLab demo extension, using `conda` package manager:
0 commit comments