@mintlify/previewing 4.0.1504 → 4.0.1506

package/export-scripts/README.md

@@ -0,0 +1,15 @@
+# Exported documentation
+
+## View locally
+
+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.
+
+## Host on your own server
+
+Serve this folder as static files with these rules:
+
+1. **Pages:** a request for `/<path>` serves `<path>/index.html`.
+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.
+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`.
+
+`serve.js` implements all three rules and can be used as a reference.

package/export-scripts/serve.js

@@ -8,6 +8,8 @@ const { execFile } = require('child_process');
 const PORT = process.env.PORT || 3000;
 const DIR = __dirname;
 
+const IMMUTABLE_PATH = /^\/(?:_next\/static|_mintlify\/assets|_mintlify\/export-assets)\//;
+
 const MIME_TYPES = {
   '.html': 'text/html',
   '.css': 'text/css',
@@ -45,6 +47,16 @@ function openInBrowser(url) {
   execFile(command, [url], () => undefined);
 }
 
+function resolveRscPayload(urlPath) {
+  const filePath = path.resolve(DIR, urlPath.replace(/^\/+/, ''), 'index.txt');
+  if (!filePath.startsWith(DIR + path.sep)) return undefined;
+  return fs.existsSync(filePath) && fs.statSync(filePath).isFile() ? filePath : undefined;
+}
+
+function isRscRequest(req) {
+  return req.headers.rsc === '1' || /[?&]_rsc=/.test(req.url || '');
+}
+
 function resolveFile(urlPath) {
   const filePath = path.resolve(DIR, urlPath.replace(/^\/+/, ''));
   if (!filePath.startsWith(DIR + path.sep) && filePath !== DIR) return undefined;
@@ -64,11 +76,18 @@ http
       return;
     }
 
-    const file = resolveFile(urlPath);
+    const rsc = isRscRequest(req);
+    const file = rsc ? resolveRscPayload(urlPath) : resolveFile(urlPath);
 
     if (file) {
       const ext = path.extname(file).toLowerCase();
-      res.writeHead(200, { 'Content-Type': MIME_TYPES[ext] || 'application/octet-stream' });
+      res.writeHead(200, {
+        'Content-Type': rsc ? 'text/x-component' : MIME_TYPES[ext] || 'application/octet-stream',
+        Vary: 'RSC',
+        'Cache-Control': IMMUTABLE_PATH.test(urlPath)
+          ? 'public, max-age=31536000, immutable'
+          : 'no-cache',
+      });
       fs.createReadStream(file).pipe(res);
     } else {
       res.writeHead(404, { 'Content-Type': 'text/plain' });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/previewing",
-  "version": "4.0.1504",
+  "version": "4.0.1506",
   "description": "Preview Mintlify docs locally",
   "engines": {
     "node": ">=18.0.0"
@@ -44,9 +44,9 @@
     "type": "tsgo --noEmit"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.1263",
-    "@mintlify/prebuild": "1.0.1428",
-    "@mintlify/validation": "0.1.924",
+    "@mintlify/common": "1.0.1265",
+    "@mintlify/prebuild": "1.0.1430",
+    "@mintlify/validation": "0.1.925",
     "adm-zip": "0.6.0",
     "better-opn": "3.0.2",
     "chalk": "5.2.0",
@@ -64,7 +64,7 @@
     "yargs": "17.7.1"
   },
   "optionalDependencies": {
-    "@mintlify/package-builder": "0.0.51"
+    "@mintlify/package-builder": "0.0.53"
   },
   "devDependencies": {
     "@mintlify/models": "0.0.375",
@@ -86,5 +86,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "44526ff73005e41a94f70daf2b159dcf07b35398"
+  "gitHead": "afa4e5cf775b14bcf04e830cdde309bfc728f439"
 }