@levino/shipyard-base 0.5.8 → 0.5.9
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 +66 -0
- package/astro/layouts/Page.astro +1 -1
- package/package.json +6 -2
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# @levino/shipyard-base
|
|
2
|
+
|
|
3
|
+
Core package for [Shipyard](https://shipyard.levinkeller.de), a general-purpose page builder for Astro.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @levino/shipyard-base
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Peer Dependencies
|
|
12
|
+
|
|
13
|
+
- `astro` ^5.7
|
|
14
|
+
- `tailwindcss` ^3
|
|
15
|
+
- `daisyui` ^4
|
|
16
|
+
- `@tailwindcss/typography` ^0.5.10
|
|
17
|
+
|
|
18
|
+
## Basic Usage
|
|
19
|
+
|
|
20
|
+
### Astro Integration
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
// astro.config.ts
|
|
24
|
+
import shipyard from '@levino/shipyard-base'
|
|
25
|
+
|
|
26
|
+
export default defineConfig({
|
|
27
|
+
integrations: [
|
|
28
|
+
shipyard({
|
|
29
|
+
title: 'My Site',
|
|
30
|
+
// ... configuration
|
|
31
|
+
}),
|
|
32
|
+
],
|
|
33
|
+
})
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Layouts
|
|
37
|
+
|
|
38
|
+
```astro
|
|
39
|
+
---
|
|
40
|
+
import { Page } from '@levino/shipyard-base/layouts'
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
<Page title="My Page">
|
|
44
|
+
<p>Page content</p>
|
|
45
|
+
</Page>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Available layouts: `Page`, `Splash`, `Footer`
|
|
49
|
+
|
|
50
|
+
### Components
|
|
51
|
+
|
|
52
|
+
```astro
|
|
53
|
+
---
|
|
54
|
+
import { SidebarNavigation, Breadcrumbs } from '@levino/shipyard-base/components'
|
|
55
|
+
---
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Available components: `Breadcrumbs`, `Footer`, `GlobalDesktopNavigation`, `LocalNavigation`, `SidebarElement`, `SidebarNavigation`, `TableOfContents`
|
|
59
|
+
|
|
60
|
+
## Documentation
|
|
61
|
+
|
|
62
|
+
For complete documentation and examples, visit [shipyard.levinkeller.de](https://shipyard.levinkeller.de).
|
|
63
|
+
|
|
64
|
+
## License
|
|
65
|
+
|
|
66
|
+
MIT
|
package/astro/layouts/Page.astro
CHANGED
|
@@ -71,7 +71,7 @@ const renderScriptAttributes = (script: Script) => {
|
|
|
71
71
|
<body>
|
|
72
72
|
<div class="drawer lg:drawer-open">
|
|
73
73
|
<input id="drawer" type="checkbox" class="drawer-toggle" />
|
|
74
|
-
<div class="drawer-content">
|
|
74
|
+
<div class="drawer-content overflow-x-hidden">
|
|
75
75
|
<div class="flex min-h-screen flex-col">
|
|
76
76
|
<GlobalDesktopNavigation
|
|
77
77
|
showBrand={!props.sidebarNavigation}
|
package/package.json
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@levino/shipyard-base",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.9",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "src/index.ts",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"test:unit": "vitest run"
|
|
8
|
+
},
|
|
6
9
|
"exports": {
|
|
7
10
|
".": "./src/index.ts",
|
|
8
11
|
"./astro": "./src/astro.ts",
|
|
@@ -31,7 +34,8 @@
|
|
|
31
34
|
"daisyui": "^4.6.0",
|
|
32
35
|
"tailwindcss": "^3.4.0",
|
|
33
36
|
"typescript": "^5.2.2",
|
|
34
|
-
"vite": "^
|
|
37
|
+
"vite": "^7",
|
|
38
|
+
"vitest": "^2.1.8"
|
|
35
39
|
},
|
|
36
40
|
"dependencies": {
|
|
37
41
|
"clsx": "^2.1.0",
|