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: CONTRIBUTING.md
+9-18Lines changed: 9 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,11 @@ Welcome to the contributing guidelines! Here you can find instructions on how to
4
4
5
5
## The Project Structure
6
6
7
-
The project uses [pnpm](https://pnpm.io/) and [pnpm workspaces](https://pnpm.io/workspaces) and is split into:
7
+
The project uses [pnpm](https://pnpm.io/) and comprises:
8
8
9
-
-**packages/docs** which uses [Astro](https://astro.build/) for the documentation
10
-
-**packages/lib** is the code for the Svelte-HeadlessUI library
9
+
-**src/docs** contains the documentation in Markdown format
10
+
-**src/routes** are examples of the components in use
11
+
-**src/lib** is the code for the Svelte-HeadlessUI library
11
12
12
13
## Setting Up The Project
13
14
@@ -17,28 +18,18 @@ From the root of the project install the project dependencies.
17
18
pnpm install
18
19
```
19
20
20
-
Build the packages in every project of a workspace.
21
+
Build the project.
21
22
22
23
```shell
23
-
pnpm -r build
24
+
pnpm build
24
25
```
25
26
26
-
## Contributing To The Documentation
27
-
28
-
From the root of the project navigate to `packages/docs` and run the development server.
29
-
30
-
```shell
31
-
cd packages/docs && pnpm run dev
32
-
```
33
-
34
-
You can open [http://localhost:3000/svelte-headlessui/](http://localhost:3000/svelte-headlessui/) in your browser to see the documentation and make changes.
35
-
36
27
## Contributing To Svelte-HeadlessUI
37
28
38
-
From the root of the project navigate to `package/lib` and run the development server.
29
+
From the root of the project run the development server.
39
30
40
31
```shell
41
-
cd packages/lib &&pnpm run dev
32
+
pnpm dev
42
33
```
43
34
44
-
You can open [http://localhost:5173/](http://localhost:5173/) in your browser to see the UI components and make changes.
35
+
You can open [http://localhost:5173/](http://localhost:5173/) in your browser to see the UI components and make changes to the components, the documentation, or the examples.
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ But also:
19
19
20
20
## BREAKING CHANGE (v0.0.39)
21
21
22
-
The latest 0.0.39 release switches to using "change" instead of "select" as the event fired when the selected item changes for semantic correctness and to better match native inputs. Be sure to change listeners from `on:select` to `on:change`!
22
+
The 0.0.39 release switched to using "change" instead of "select" as the event fired when the selected item changes for semantic correctness and to better match native inputs. Be sure to change listeners from `onselect` to `onchange`!
23
23
24
24
## Installation
25
25
@@ -37,4 +37,4 @@ You may be interested in evaluating [@rgossiaux/svelte-headlessui](https://svelt
37
37
38
38
## Logo
39
39
40
-
Special thanks to [Shoob](https://github.com/hshoob) for the logo!
40
+
Special thanks to [Shoob](https://github.com/hshoob) for the awesome logo!
0 commit comments