@better-svelte-email/server 2.0.0 → 2.0.1
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 +7 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,10 @@
|
|
|
1
1
|
# @better-svelte-email/server
|
|
2
2
|
|
|
3
|
-
> [!WARNING]
|
|
4
|
-
> This package is still in **beta**; APIs and behavior may change before a stable release.
|
|
3
|
+
<!-- > [!WARNING]
|
|
4
|
+
> This package is still in **beta**; APIs and behavior may change before a stable release. -->
|
|
5
5
|
|
|
6
6
|
Server-side renderer for Better Svelte Email: compile Tailwind-aware Svelte components into **email-safe HTML** (styles inlined, markup adapted for clients).
|
|
7
7
|
|
|
8
|
-
Used by `[better-svelte-email](https://www.npmjs.com/package/better-svelte-email)`, `[@better-svelte-email/components](../components)`, `[@better-svelte-email/preview](../preview)`, and the `[@better-svelte-email/cli](../cli)`.
|
|
9
|
-
|
|
10
8
|
## Install
|
|
11
9
|
|
|
12
10
|
```bash
|
|
@@ -15,6 +13,10 @@ npm i @better-svelte-email/server
|
|
|
15
13
|
|
|
16
14
|
**Peer dependency:** `svelte` >= **5.14.3**
|
|
17
15
|
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
Please refer to the [documentation](https://better-svelte-email.konixy.dev/docs) for a usage guide and implementation examples.
|
|
19
|
+
|
|
18
20
|
## Exports
|
|
19
21
|
|
|
20
22
|
The main entry exposes:
|
|
@@ -24,27 +26,12 @@ The main entry exposes:
|
|
|
24
26
|
- **Types** — `TailwindConfig`, `RendererOptions`, `RenderOptions`, `AST`, etc.
|
|
25
27
|
- **`pixelBasedPreset`** — Tailwind-related helper for pixel-oriented email styling
|
|
26
28
|
|
|
27
|
-
See JSDoc in the source and the [project documentation](https://better-svelte-email.konixy.dev/docs) for examples.
|
|
29
|
+
See JSDoc in the source and the [project documentation](https://better-svelte-email.konixy.dev/docs/render) for examples.
|
|
28
30
|
|
|
29
31
|
## Monorepo
|
|
30
32
|
|
|
31
33
|
[github.com/Konixy/better-svelte-email](https://github.com/Konixy/better-svelte-email) — `packages/server`.
|
|
32
34
|
|
|
33
|
-
## Development
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
bun run build --filter=@better-svelte-email/server
|
|
37
|
-
bun run test --filter=@better-svelte-email/server
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Package-local:
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
bun run build
|
|
44
|
-
bun run test
|
|
45
|
-
bun run lint
|
|
46
|
-
```
|
|
47
|
-
|
|
48
35
|
## License
|
|
49
36
|
|
|
50
37
|
MIT
|