@kuckit/docs-module 0.1.3 → 2.0.6
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/package.json +30 -7
- package/templates/index.mdx +43 -0
package/package.json
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kuckit/docs-module",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "2.0.6",
|
|
4
4
|
"description": "Documentation module for Kuckit using Fumadocs",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/server/module.js",
|
|
7
7
|
"types": "dist/server/module.d.ts",
|
|
8
8
|
"files": [
|
|
9
|
-
"dist"
|
|
9
|
+
"dist",
|
|
10
|
+
"templates"
|
|
10
11
|
],
|
|
11
12
|
"exports": {
|
|
12
13
|
".": {
|
|
@@ -21,22 +22,44 @@
|
|
|
21
22
|
"kuckit": {
|
|
22
23
|
"id": "kuckit.docs",
|
|
23
24
|
"server": ".",
|
|
24
|
-
"client": "./client"
|
|
25
|
+
"client": "./client",
|
|
26
|
+
"setup": {
|
|
27
|
+
"scaffolds": [
|
|
28
|
+
{
|
|
29
|
+
"type": "directory",
|
|
30
|
+
"path": "content/docs"
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
"type": "template",
|
|
34
|
+
"src": "templates/index.mdx",
|
|
35
|
+
"dest": "content/docs/index.mdx"
|
|
36
|
+
}
|
|
37
|
+
],
|
|
38
|
+
"configDefaults": {
|
|
39
|
+
"docsDir": "content/docs",
|
|
40
|
+
"basePath": "/docs"
|
|
41
|
+
},
|
|
42
|
+
"devDependencies": {
|
|
43
|
+
"@tailwindcss/typography": "^0.5"
|
|
44
|
+
},
|
|
45
|
+
"postInstallMessage": "📚 Docs module setup complete!\n\n ✅ Created content/docs/ directory with starter page\n ✅ Installed @tailwindcss/typography in apps/web\n\n ⚠️ Add the following to your CSS file (e.g., apps/web/src/index.css):\n\n @plugin \"@tailwindcss/typography\";\n @source \"../node_modules/@kuckit/docs-module/dist/**/*.js\";\n\n See SETUP.md for full configuration: https://github.com/draphonix/kuckit"
|
|
46
|
+
}
|
|
25
47
|
},
|
|
26
48
|
"scripts": {
|
|
27
49
|
"build": "tsdown",
|
|
28
50
|
"prepublishOnly": "npm run build && node ../../scripts/resolve-workspace-protocols.cjs && node ../../scripts/check-no-workspace-protocol.cjs"
|
|
29
51
|
},
|
|
30
52
|
"peerDependencies": {
|
|
31
|
-
"@kuckit/sdk": "^2.0.
|
|
32
|
-
"@kuckit/sdk-react": "^2.0.
|
|
53
|
+
"@kuckit/sdk": "^2.0.6",
|
|
54
|
+
"@kuckit/sdk-react": "^2.0.6",
|
|
55
|
+
"@tailwindcss/typography": "^0.5",
|
|
33
56
|
"@tanstack/react-router": "^1",
|
|
34
57
|
"react": "^18 || ^19",
|
|
35
58
|
"typescript": "^5"
|
|
36
59
|
},
|
|
37
60
|
"dependencies": {
|
|
38
|
-
"@kuckit/api": "^2.0.
|
|
39
|
-
"@kuckit/domain": "^2.0.
|
|
61
|
+
"@kuckit/api": "^2.0.6",
|
|
62
|
+
"@kuckit/domain": "^2.0.6",
|
|
40
63
|
"@fumadocs/mdx-remote": "^1.3.0",
|
|
41
64
|
"fumadocs-core": "^15.3.1",
|
|
42
65
|
"fumadocs-ui": "^15.3.1",
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Welcome to Documentation
|
|
3
|
+
description: Getting started with your Kuckit documentation
|
|
4
|
+
order: 1
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Welcome
|
|
8
|
+
|
|
9
|
+
This is your documentation home page. Edit this file at `content/docs/index.mdx`.
|
|
10
|
+
|
|
11
|
+
## Getting Started
|
|
12
|
+
|
|
13
|
+
Create new documentation pages by adding `.mdx` files to the `content/docs/` directory.
|
|
14
|
+
|
|
15
|
+
### File Structure
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
content/
|
|
19
|
+
└── docs/
|
|
20
|
+
├── index.mdx # /docs (this page)
|
|
21
|
+
├── getting-started.mdx # /docs/getting-started
|
|
22
|
+
└── guides/
|
|
23
|
+
├── index.mdx # /docs/guides
|
|
24
|
+
└── example.mdx # /docs/guides/example
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### Frontmatter
|
|
28
|
+
|
|
29
|
+
Each MDX file supports frontmatter for metadata:
|
|
30
|
+
|
|
31
|
+
```mdx
|
|
32
|
+
---
|
|
33
|
+
title: Page Title
|
|
34
|
+
description: Optional description for search
|
|
35
|
+
order: 1 # Lower numbers appear first in sidebar
|
|
36
|
+
---
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Next Steps
|
|
40
|
+
|
|
41
|
+
- Create your first guide in `content/docs/guides/`
|
|
42
|
+
- Customize styling with Tailwind prose classes
|
|
43
|
+
- Add versioned documentation for multiple releases
|