fairy-ring 0.0.0-stage → 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -2
- package/dist/element.d.ts +2 -0
- package/dist/element.js +6 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +0 -0
- package/dist/react.d.ts +2 -0
- package/dist/react.js +8 -0
- package/dist/solid.d.ts +1 -0
- package/dist/solid.js +7 -0
- package/dist/standalone.js +1 -0
- package/dist/vue.d.ts +2 -0
- package/dist/vue.js +8 -0
- package/package.json +81 -3
package/README.md
CHANGED
|
@@ -1,3 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# fairy-ring
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
make webrings!
|
|
4
|
+
|
|
5
|
+
easy, customizable, ultramodern library for making your own webring. not a webring itself.
|
|
6
|
+
|
|
7
|
+
<details>
|
|
8
|
+
<summary>webring?</summary>
|
|
9
|
+
|
|
10
|
+
a webring is a collection of websites that link to each other, such that the links form a ring. A <-> B <-> C <-> A ...
|
|
11
|
+
|
|
12
|
+
each site has a "next" and a "previous" link so a user can browse through the ring.
|
|
13
|
+
|
|
14
|
+
it's an alternative method of content discovery with a long history.
|
|
15
|
+
|
|
16
|
+
</details>
|
|
17
|
+
|
|
18
|
+
<details>
|
|
19
|
+
<summary>development philosophy</summary>
|
|
20
|
+
|
|
21
|
+
use bleeding-edge web tooling to deliver a simple and fun developer and user experience.
|
|
22
|
+
|
|
23
|
+
</details>
|
|
24
|
+
|
|
25
|
+
## how?
|
|
26
|
+
|
|
27
|
+
1. write a fairy-ring config file in TOML and put it on the internet
|
|
28
|
+
2. embed your fairy-ring using a tiny snippet:
|
|
29
|
+
|
|
30
|
+
```html
|
|
31
|
+
<script type="module" src="https://cdn.jsdelivr.net/npm/fairy-ring/dist/standalone.js"></script>
|
|
32
|
+
<fairy-ring config-url="https://your-site.example/fairy-ring.toml"></fairy-ring>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
or use one of the framework wrappers: React, Vue, SolidJS.
|
|
36
|
+
|
|
37
|
+
## development
|
|
38
|
+
|
|
39
|
+
Install:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pnpm i
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Run storybook:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pnpm dev
|
|
49
|
+
```
|
package/dist/element.js
ADDED
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export interface FairyRingOptions {}
|
package/dist/index.js
ADDED
|
File without changes
|
package/dist/react.d.ts
ADDED
package/dist/react.js
ADDED
package/dist/solid.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function FairyRing(): HTMLElement;
|
package/dist/solid.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var e=class extends HTMLElement{};function t(t=`fairy-ring`){customElements.get(t)||customElements.define(t,e)}t();export{e as FairyRingElement,t as define};
|
package/dist/vue.d.ts
ADDED
package/dist/vue.js
ADDED
package/package.json
CHANGED
|
@@ -1,6 +1,84 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fairy-ring",
|
|
3
|
-
"version": "0.0.0
|
|
4
|
-
"
|
|
5
|
-
"
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "",
|
|
5
|
+
"license": "ISC",
|
|
6
|
+
"files": [
|
|
7
|
+
"dist"
|
|
8
|
+
],
|
|
9
|
+
"type": "module",
|
|
10
|
+
"sideEffects": [
|
|
11
|
+
"./dist/standalone.js"
|
|
12
|
+
],
|
|
13
|
+
"exports": {
|
|
14
|
+
".": {
|
|
15
|
+
"types": "./dist/index.d.ts",
|
|
16
|
+
"default": "./dist/index.js"
|
|
17
|
+
},
|
|
18
|
+
"./element": {
|
|
19
|
+
"types": "./dist/element.d.ts",
|
|
20
|
+
"default": "./dist/element.js"
|
|
21
|
+
},
|
|
22
|
+
"./standalone": "./dist/standalone.js",
|
|
23
|
+
"./react": {
|
|
24
|
+
"types": "./dist/react.d.ts",
|
|
25
|
+
"default": "./dist/react.js"
|
|
26
|
+
},
|
|
27
|
+
"./vue": {
|
|
28
|
+
"types": "./dist/vue.d.ts",
|
|
29
|
+
"default": "./dist/vue.js"
|
|
30
|
+
},
|
|
31
|
+
"./solid": {
|
|
32
|
+
"types": "./dist/solid.d.ts",
|
|
33
|
+
"default": "./dist/solid.js"
|
|
34
|
+
},
|
|
35
|
+
"./package.json": "./package.json"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@changesets/cli": "^3.0.3",
|
|
39
|
+
"@storybook/addon-vitest": "^10.6.7",
|
|
40
|
+
"@storybook/web-components-vite": "^10.6.7",
|
|
41
|
+
"@types/react": "^19.3.0",
|
|
42
|
+
"@vitest/browser-playwright": "^5.1.1",
|
|
43
|
+
"oxfmt": "^0.79.0",
|
|
44
|
+
"oxlint": "^1.94.0",
|
|
45
|
+
"playwright": "^1.65.1",
|
|
46
|
+
"react": "^19.3.1",
|
|
47
|
+
"solid-js": "^2.0.1",
|
|
48
|
+
"storybook": "^10.6.7",
|
|
49
|
+
"tsdown": "^0.23.7",
|
|
50
|
+
"typescript": "7.1.0-beta",
|
|
51
|
+
"vite": "^8.3.8",
|
|
52
|
+
"vitest": "^5.1.1",
|
|
53
|
+
"vue": "^3.5.45"
|
|
54
|
+
},
|
|
55
|
+
"peerDependencies": {
|
|
56
|
+
"react": "^19.0.0",
|
|
57
|
+
"solid-js": "^2.0.0",
|
|
58
|
+
"vue": "^3.5.0"
|
|
59
|
+
},
|
|
60
|
+
"peerDependenciesMeta": {
|
|
61
|
+
"react": {
|
|
62
|
+
"optional": true
|
|
63
|
+
},
|
|
64
|
+
"vue": {
|
|
65
|
+
"optional": true
|
|
66
|
+
},
|
|
67
|
+
"solid-js": {
|
|
68
|
+
"optional": true
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
"scripts": {
|
|
72
|
+
"build": "tsdown",
|
|
73
|
+
"dev": "storybook dev -p 6006",
|
|
74
|
+
"typecheck": "tsc --noEmit",
|
|
75
|
+
"lint": "oxlint",
|
|
76
|
+
"format": "oxfmt",
|
|
77
|
+
"format:check": "oxfmt --check",
|
|
78
|
+
"changeset": "changeset",
|
|
79
|
+
"release": "pnpm build && changeset publish",
|
|
80
|
+
"build-storybook": "storybook build",
|
|
81
|
+
"test": "./scripts/test.sh",
|
|
82
|
+
"test:update": "./scripts/test.sh --update"
|
|
83
|
+
}
|
|
6
84
|
}
|