@mintlify/previewing 4.0.1588 → 4.0.1590
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/dist/__tests__/dev.test.js +3 -3
- package/dist/__tests__/export-assets.test.js +9 -5
- package/dist/__tests__/export-vite.test.d.ts +1 -0
- package/dist/__tests__/export-vite.test.js +101 -0
- package/dist/__tests__/export.test.js +2 -1
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +2 -2
- package/dist/local-preview/export-assets.d.ts +4 -1
- package/dist/local-preview/export-assets.js +6 -6
- package/dist/local-preview/export-next.d.ts +3 -0
- package/dist/local-preview/export-next.js +68 -0
- package/dist/local-preview/export-pages.d.ts +16 -0
- package/dist/local-preview/export-pages.js +36 -0
- package/dist/local-preview/export-vite.d.ts +9 -0
- package/dist/local-preview/export-vite.js +90 -0
- package/dist/local-preview/export.d.ts +0 -1
- package/dist/local-preview/export.js +24 -89
- package/dist/local-preview/index.js +1 -8
- package/dist/local-preview/setupVite.d.ts +9 -0
- package/dist/local-preview/setupVite.js +15 -2
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/export-scripts/README.classic.md +15 -0
- package/export-scripts/README.md +2 -3
- package/package.json +5 -5
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Exported documentation
|
|
2
|
+
|
|
3
|
+
## View locally
|
|
4
|
+
|
|
5
|
+
Run `node serve.js` (or double-click `Start Docs.command` on macOS, `Start Docs.bat` on Windows) and open `http://localhost:3000`. Requires Node.js.
|
|
6
|
+
|
|
7
|
+
## Host on your own server
|
|
8
|
+
|
|
9
|
+
Serve this folder as static files with these rules:
|
|
10
|
+
|
|
11
|
+
1. **Pages:** a request for `/<path>` serves `<path>/index.html`.
|
|
12
|
+
2. **Client-side navigation:** a request with an `RSC: 1` header or an `_rsc` query parameter serves `<path>/index.txt` with `Content-Type: text/x-component` and `Vary: RSC`. Without this rule, every link click is a full page load and link prefetches download whole HTML pages.
|
|
13
|
+
3. **Caching:** serve `_next/static/*` and `_mintlify/export-assets/*` with `Cache-Control: public, max-age=31536000, immutable`, and pages and `index.txt` files with `Cache-Control: no-cache`.
|
|
14
|
+
|
|
15
|
+
`serve.js` implements all three rules and can be used as a reference.
|
package/export-scripts/README.md
CHANGED
|
@@ -9,7 +9,6 @@ Run `node serve.js` (or double-click `Start Docs.command` on macOS, `Start Docs.
|
|
|
9
9
|
Serve this folder as static files with these rules:
|
|
10
10
|
|
|
11
11
|
1. **Pages:** a request for `/<path>` serves `<path>/index.html`.
|
|
12
|
-
2. **
|
|
13
|
-
3. **Caching:** serve `_next/static/*` and `_mintlify/export-assets/*` with `Cache-Control: public, max-age=31536000, immutable`, and pages and `index.txt` files with `Cache-Control: no-cache`.
|
|
12
|
+
2. **Caching:** serve `_mintlify/assets/*` and `_mintlify/export-assets/*` with `Cache-Control: public, max-age=31536000, immutable`, and pages with `Cache-Control: no-cache`.
|
|
14
13
|
|
|
15
|
-
`serve.js` implements
|
|
14
|
+
`serve.js` implements both rules and can be used as a reference.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/previewing",
|
|
3
|
-
"version": "4.0.
|
|
3
|
+
"version": "4.0.1590",
|
|
4
4
|
"description": "Preview Mintlify docs locally",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -44,8 +44,8 @@
|
|
|
44
44
|
"type": "tsgo --noEmit"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@mintlify/common": "1.0.
|
|
48
|
-
"@mintlify/prebuild": "1.0.
|
|
47
|
+
"@mintlify/common": "1.0.1333",
|
|
48
|
+
"@mintlify/prebuild": "1.0.1505",
|
|
49
49
|
"@mintlify/validation": "0.1.955",
|
|
50
50
|
"adm-zip": "0.6.0",
|
|
51
51
|
"better-opn": "3.0.2",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"yargs": "17.7.1"
|
|
66
66
|
},
|
|
67
67
|
"optionalDependencies": {
|
|
68
|
-
"@mintlify/package-builder": "0.0.
|
|
68
|
+
"@mintlify/package-builder": "0.0.122"
|
|
69
69
|
},
|
|
70
70
|
"devDependencies": {
|
|
71
71
|
"@mintlify/models": "0.0.384",
|
|
@@ -88,5 +88,5 @@
|
|
|
88
88
|
"vitest": "2.1.9",
|
|
89
89
|
"vitest-mock-process": "1.0.4"
|
|
90
90
|
},
|
|
91
|
-
"gitHead": "
|
|
91
|
+
"gitHead": "5e9b7c7944ed6cf33cacc2dfb8489d5be726c720"
|
|
92
92
|
}
|