jamdesk 1.0.21 → 1.0.23
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 -15
- package/package.json +3 -4
- package/vendored/app/layout.tsx +11 -0
- package/vendored/lib/docs-types.ts +1 -0
- package/vendored/schema/docs-schema.json +13 -0
package/README.md
CHANGED
|
@@ -15,10 +15,10 @@ Jamdesk is a docs-as-code platform. Connect a GitHub repo, write in MDX, and you
|
|
|
15
15
|
- **Dev server** — Turbopack-powered with hot reload on every save
|
|
16
16
|
- **50+ MDX components** — accordions, tabs, code groups, callouts, [and more](https://www.jamdesk.com/docs/components/overview)
|
|
17
17
|
- **Three themes** — Jam, Nebula, Pulsar. Configured in `docs.json`
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
18
|
+
- Auto-generate API reference pages from OpenAPI specs
|
|
19
|
+
- Full-text search works locally and in production (AI search on hosted sites)
|
|
20
|
+
- Catches broken links, MDX syntax errors, and config issues before you deploy
|
|
21
|
+
- Migrate from Mintlify in one command
|
|
22
22
|
|
|
23
23
|
## Quick Start
|
|
24
24
|
|
|
@@ -120,13 +120,7 @@ jamdesk dev --port 3001 # Custom port
|
|
|
120
120
|
|
|
121
121
|
The dev server auto-validates on startup, auto-recovers from corrupted Turbopack cache, and auto-increments the port if yours is taken. Full search, all themes, and all components work locally.
|
|
122
122
|
|
|
123
|
-
Set a default port in `~/.jamdeskrc
|
|
124
|
-
|
|
125
|
-
```json
|
|
126
|
-
{
|
|
127
|
-
"defaultPort": 3001
|
|
128
|
-
}
|
|
129
|
-
```
|
|
123
|
+
Set a default port in [`~/.jamdeskrc`](#cli-defaults).
|
|
130
124
|
|
|
131
125
|
## Authentication
|
|
132
126
|
|
|
@@ -235,8 +229,8 @@ Detects your `mint.json`, converts config to `docs.json`, lets you pick a theme,
|
|
|
235
229
|
|
|
236
230
|
- **Config** — `mint.json` → `docs.json` (navbar, navigation, footer, SEO, appearance)
|
|
237
231
|
- **Components** — deprecated components like `<CardGroup>` → `<Columns>`
|
|
238
|
-
-
|
|
239
|
-
-
|
|
232
|
+
- Inline components with `useState`/`useEffect` get extracted to `/snippets` as `'use client'` `.tsx` files
|
|
233
|
+
- iframe video embeds are normalized
|
|
240
234
|
|
|
241
235
|
| Option | Description |
|
|
242
236
|
|--------|-------------|
|
|
@@ -396,8 +390,6 @@ See the [docs.json reference](https://www.jamdesk.com/docs/config/docs-json-refe
|
|
|
396
390
|
- [Homepage](https://www.jamdesk.com)
|
|
397
391
|
- [Pricing](https://www.jamdesk.com/pricing)
|
|
398
392
|
|
|
399
|
-
**Example:** [jamdesk.com/docs](https://www.jamdesk.com/docs)
|
|
400
|
-
|
|
401
393
|
## Support
|
|
402
394
|
|
|
403
395
|
- [Report Issues](https://github.com/jamdesk/jamdesk-cli/issues)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "jamdesk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.23",
|
|
4
4
|
"description": "CLI for Jamdesk — build, preview, and deploy documentation sites from MDX. Dev server with hot reload, 50+ components, OpenAPI support, AI search, and Mintlify migration",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"jamdesk",
|
|
@@ -39,8 +39,7 @@
|
|
|
39
39
|
},
|
|
40
40
|
"repository": {
|
|
41
41
|
"type": "git",
|
|
42
|
-
"url": "https://github.com/jamdesk/jamdesk.git"
|
|
43
|
-
"directory": "builder/cli"
|
|
42
|
+
"url": "git+https://github.com/jamdesk/jamdesk-cli.git"
|
|
44
43
|
},
|
|
45
44
|
"license": "Apache-2.0",
|
|
46
45
|
"author": {
|
|
@@ -50,7 +49,7 @@
|
|
|
50
49
|
},
|
|
51
50
|
"type": "module",
|
|
52
51
|
"bin": {
|
|
53
|
-
"jamdesk": "
|
|
52
|
+
"jamdesk": "bin/jamdesk.js"
|
|
54
53
|
},
|
|
55
54
|
"main": "./dist/index.js",
|
|
56
55
|
"types": "./dist/index.d.ts",
|
package/vendored/app/layout.tsx
CHANGED
|
@@ -377,6 +377,9 @@ export default async function RootLayout({
|
|
|
377
377
|
}
|
|
378
378
|
})()} />
|
|
379
379
|
)}
|
|
380
|
+
{config.integrations?.crisp && (
|
|
381
|
+
<link rel="dns-prefetch" href="https://client.crisp.chat" />
|
|
382
|
+
)}
|
|
380
383
|
{config.integrations?.intercom && (
|
|
381
384
|
<link rel="dns-prefetch" href="https://widget.intercom.io" />
|
|
382
385
|
)}
|
|
@@ -504,6 +507,14 @@ export default async function RootLayout({
|
|
|
504
507
|
<CodeBlockCopyButton />
|
|
505
508
|
<HeaderLinkCopy />
|
|
506
509
|
</ThemeProvider>
|
|
510
|
+
{/* Crisp Chat */}
|
|
511
|
+
{config.integrations?.crisp?.websiteId && (
|
|
512
|
+
<script
|
|
513
|
+
dangerouslySetInnerHTML={{
|
|
514
|
+
__html: `window.$crisp=[];window.CRISP_WEBSITE_ID="${config.integrations.crisp.websiteId}";(function(){var d=document;var s=d.createElement("script");s.src="https://client.crisp.chat/l.js";s.async=1;d.getElementsByTagName("head")[0].appendChild(s)})();`,
|
|
515
|
+
}}
|
|
516
|
+
/>
|
|
517
|
+
)}
|
|
507
518
|
{/* Custom JavaScript - loaded at end of body */}
|
|
508
519
|
{/* Custom JS comes from R2 via assets API with project context */}
|
|
509
520
|
{config._hasCustomJs && (
|
|
@@ -588,6 +588,7 @@ export interface IntegrationsConfig {
|
|
|
588
588
|
heap?: { appId: string };
|
|
589
589
|
hightouch?: { writeKey: string; apiHost?: string };
|
|
590
590
|
hotjar?: { hjid: string; hjsv: string };
|
|
591
|
+
crisp?: { websiteId: string };
|
|
591
592
|
intercom?: { appId: string };
|
|
592
593
|
koala?: { publicApiKey: string };
|
|
593
594
|
logrocket?: { appId: string };
|
|
@@ -1040,6 +1040,19 @@
|
|
|
1040
1040
|
],
|
|
1041
1041
|
"additionalProperties": false
|
|
1042
1042
|
},
|
|
1043
|
+
"crisp": {
|
|
1044
|
+
"type": "object",
|
|
1045
|
+
"properties": {
|
|
1046
|
+
"websiteId": {
|
|
1047
|
+
"type": "string",
|
|
1048
|
+
"minLength": 8
|
|
1049
|
+
}
|
|
1050
|
+
},
|
|
1051
|
+
"required": [
|
|
1052
|
+
"websiteId"
|
|
1053
|
+
],
|
|
1054
|
+
"additionalProperties": false
|
|
1055
|
+
},
|
|
1043
1056
|
"intercom": {
|
|
1044
1057
|
"type": "object",
|
|
1045
1058
|
"properties": {
|