@levino/shipyard-docs 0.5.0 → 0.5.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 +73 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @levino/shipyard-docs
|
|
2
|
+
|
|
3
|
+
Documentation plugin for [Shipyard](https://shipyard.levinkeller.de), a general-purpose page builder for Astro.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @levino/shipyard-docs
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Peer Dependencies
|
|
12
|
+
|
|
13
|
+
- `astro` ^5.15
|
|
14
|
+
|
|
15
|
+
## Basic Usage
|
|
16
|
+
|
|
17
|
+
### Astro Integration
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
// astro.config.ts
|
|
21
|
+
import shipyardDocs from '@levino/shipyard-docs'
|
|
22
|
+
|
|
23
|
+
export default defineConfig({
|
|
24
|
+
integrations: [
|
|
25
|
+
shipyardDocs({
|
|
26
|
+
routeBasePath: 'docs',
|
|
27
|
+
editUrl: 'https://github.com/user/repo/edit/main/docs',
|
|
28
|
+
showLastUpdateTime: true,
|
|
29
|
+
showLastUpdateAuthor: true,
|
|
30
|
+
}),
|
|
31
|
+
],
|
|
32
|
+
})
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Content Collection
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
// content.config.ts
|
|
39
|
+
import { defineCollection } from 'astro:content'
|
|
40
|
+
import { createDocsCollection } from '@levino/shipyard-docs'
|
|
41
|
+
|
|
42
|
+
const docs = defineCollection(createDocsCollection('./docs'))
|
|
43
|
+
|
|
44
|
+
export const collections = { docs }
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Multiple Documentation Instances
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
// astro.config.ts
|
|
51
|
+
export default defineConfig({
|
|
52
|
+
integrations: [
|
|
53
|
+
shipyardDocs({ routeBasePath: 'docs' }),
|
|
54
|
+
shipyardDocs({ routeBasePath: 'guides', collectionName: 'guides' }),
|
|
55
|
+
],
|
|
56
|
+
})
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Routes
|
|
60
|
+
|
|
61
|
+
The integration automatically injects these routes:
|
|
62
|
+
|
|
63
|
+
- `/[routeBasePath]/[...slug]` - Documentation pages
|
|
64
|
+
|
|
65
|
+
With i18n enabled, routes are prefixed with `[locale]`.
|
|
66
|
+
|
|
67
|
+
## Documentation
|
|
68
|
+
|
|
69
|
+
For complete documentation and examples, visit [shipyard.levinkeller.de](https://shipyard.levinkeller.de).
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@levino/shipyard-docs",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "src/index.ts",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"effect": "^3.12.5",
|
|
18
18
|
"ramda": "^0.31",
|
|
19
|
-
"@levino/shipyard-base": "^0.5.
|
|
19
|
+
"@levino/shipyard-base": "^0.5.9"
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
22
|
"@tailwindcss/typography": "^0.5.16",
|