@vercel/geistdocs 1.19.2 → 1.19.4
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/cli/index.js +1 -1
- package/dist/internal/markdown-url.d.ts +8 -0
- package/dist/internal/markdown-url.d.ts.map +1 -0
- package/dist/internal/markdown-url.js +9 -0
- package/dist/internal/navbar/navbar-logo.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-logo.js +1 -3
- package/dist/internal/smart-not-found.d.ts +23 -0
- package/dist/internal/smart-not-found.d.ts.map +1 -0
- package/dist/internal/smart-not-found.js +207 -0
- package/dist/pages/docs.d.ts +1 -1
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +3 -9
- package/dist/routes/llms.d.ts +30 -4
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.js +186 -5
- package/dist/source.d.ts +25 -0
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +5 -0
- package/docs/agents.md +1 -1
- package/docs/llms.txt +24 -1
- package/docs/manifest.json +1 -1
- package/docs/pages/md.md +22 -0
- package/docs/pages/migration.md +1 -0
- package/package.json +1 -1
- package/template/app/[lang]/llms.mdx/[[...slug]]/route.ts +1 -0
- package/template/content/docs/md.mdx +22 -0
- package/template/content/docs/migration.mdx +1 -0
- package/template/package.json +1 -1
package/dist/cli/index.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
import{program as T}from"commander";import{access as ce,copyFile as le}from"fs/promises";import{join as pe}from"path";import{cancel as de,intro as ge,isCancel as ue,log as fe,outro as me,spinner as he,text as we}from"@clack/prompts";import{spawn as te}from"child_process";import{readFileSync as se}from"fs";import{cp as ne,readFile as ae,rename as re,writeFile as ie}from"fs/promises";import{join as $}from"path";import{fileURLToPath as oe}from"url";var g="@vercel/geistdocs",m=(e,t=[],s={})=>new Promise((n,a)=>{let r=te(e,t,{stdio:"inherit",...s});r.on("error",a),r.on("close",i=>{if(i===0){n();return}a(new Error(`Command failed with exit code ${i}: ${[e,...t].join(" ")}`))})}),A=["dependencies","devDependencies","optionalDependencies","peerDependencies"],_=()=>JSON.parse(se(new URL("../../package.json",import.meta.url),"utf8")).version,P=async e=>{let t=$(e,"package.json"),s=await ae(t,"utf8");return JSON.parse(s)},x=async(e,t)=>{let s=$(e,"package.json");await ie(s,`${JSON.stringify(t,null,2)}
|
|
3
|
-
`,"utf8")},R=(e,t)=>{for(let s of A){let n=e[s];if(n&&t in n)return n[t]}},V=(e,t)=>!!R(e,t),b=(e,t,s)=>{let n=!1;for(let a of A){let r=e[a];r&&t in r&&(r[t]=s,n=!0)}return n},j=()=>oe(new URL("../../template",import.meta.url)),F=async e=>{await ne(j(),e,{recursive:!0});let t=$(e,".gitignore"),s=$(e,"_gitignore");try{await re(s,t)}catch{}};var ye=async e=>{await F(e)},Pe=async e=>{try{return await ce(e),!0}catch{return!1}},ve=async()=>{await Pe(".env.example")&&await le(".env.example",".env.local")},Te=async e=>{let t=await P(e),s=_();return b(t,g,s)?(await x(e,t),!0):!1},ke=async e=>{await m("pnpm",["install"],{cwd:e,env:process.env,stdio:"inherit"})},$e=async e=>{await m("git",["init"],{cwd:e,env:process.env,stdio:"inherit"}),await m("git",["add","."],{cwd:e,env:process.env,stdio:"inherit"}),await m("git",["commit","-m","\u2728 Initial commit"],{cwd:e,env:process.env,stdio:"inherit"})},xe=async()=>{let e=await we({message:"What is your project named?",placeholder:"my-app",validate(t){if(t.length===0)return"Please enter a project name."}});return ue(e)&&(de("Operation cancelled."),process.exit(0)),e.toString()},G=async e=>{try{ge("Let's start a Geistdocs project!");let t=process.cwd(),s=e.name||await xe(),n=he(),a=pe(t,s);n.start("Copying bundled template..."),await ye(s),n.message("Setting up environment variables..."),process.chdir(a),await ve(),n.message("Rewriting package dependency versions..."),await Te(a),n.message("Installing dependencies..."),await ke(a),e.disableGit||(n.message("Initializing Git repository..."),await $e(a)),n.stop("Project initialized successfully!"),me("Run `pnpm dev` to start the development server.")}catch(t){let s=t instanceof Error?t.message:`Failed to initialize project: ${t}`;fe.error(s),process.exit(1)}};import{readFileSync as be,writeFileSync as Fe}from"fs";import{mkdir as De,readFile as N,writeFile as Se}from"fs/promises";import{dirname as Ce,extname as Re,relative as M,resolve as S}from"path";import{intro as je,isCancel as Ee,log as h,multiselect as Ne,outro as D,spinner as Ue}from"@clack/prompts";import{glob as Oe}from"glob";import{Node as v,Project as Ie,SyntaxKind as Je}from"ts-morph";var Le="geistdocs.tsx",Ae="content/docs/**/*.mdx",U=".translation-cache.json",E=8,B=()=>({version:1,entries:{}}),_e=async e=>{let t=await N(e),{createHash:s}=await import("crypto");return s("sha256").update(t).digest("hex")},Ve=e=>{let t=S(process.cwd(),e);return be(t,"utf8")},z=e=>v.isObjectLiteralExpression(e)?e.getProperties().flatMap(t=>{if(v.isPropertyAssignment(t)){let s=t.getNameNode();if(v.isIdentifier(s)||v.isStringLiteral(s))return[s.getText().replaceAll(/['"]/g,"")]}return[]}).filter(Boolean):[],Ge=e=>{try{let t=new Ie({compilerOptions:{allowJs:!0,jsx:4,module:99,target:10},skipAddingFilesFromTsConfig:!0,useInMemoryFileSystem:!0}),s=Ve(e),r=t.createSourceFile(e,s,{overwrite:!0}).getVariableDeclarations().find(l=>l.getName()==="translations")?.getInitializer();if(!r)return[];if(v.isObjectLiteralExpression(r))return z(r);let i=r.getFirstDescendantByKind(Je.ObjectLiteralExpression);return i?z(i):[]}catch(t){let s=t instanceof Error?t.message:`${t}`;return h.warn(`Failed to read locales from ${e}: ${s}`),[]}},Be=async()=>{let e=await Ne({message:"Which locales should be translated?",options:[{value:"cn",label:"Chinese (cn)"},{value:"jp",label:"Japanese (jp)"},{value:"es",label:"Spanish (es)"},{value:"fr",label:"French (fr)"},{value:"de",label:"German (de)"}],required:!0});return Ee(e)&&(D("Translation cancelled"),process.exit(0)),e},ze=async e=>(await Oe(e,{cwd:process.cwd(),absolute:!0,nodir:!0})).sort(),He=async()=>{let e=S(process.cwd(),U);try{let t=await N(e,"utf8"),s=JSON.parse(t);return s.version!==1||!s.entries?B():{version:1,entries:s.entries}}catch{return B()}},H=e=>{let t=S(process.cwd(),U),s=JSON.stringify(e,null,2);Fe(t,s,"utf8")},Me=async e=>{let t=await Promise.all(e.map(async s=>[s,await _e(s)]));return Object.fromEntries(t)},Ke=(e,t)=>{let s=Re(e);return`${e.slice(0,-s.length)}.${t}${s}`},K=(e,t)=>`${M(process.cwd(),e)}::${t}`,qe=(e,t,s,n,a=!1)=>{let r=[],i=0;for(let l of t){let c=s[l];for(let o of e){let d=Ke(l,o),u=K(l,o),f=n.entries[u];if(!a&&f?.hash===c){i+=1;continue}r.push({locale:o,sourceFile:l,sourceHash:c,targetFile:d})}}return{tasks:r,skippedCount:i}},Xe=async e=>{await De(Ce(e),{recursive:!0})},We=async(e,t,s)=>{let n=await fetch(e,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({content:t,locale:s})});if(!n.ok){let r=await n.text();throw new Error(`API request failed (${n.status}): ${r}`)}let a=await n.json();if(!a.translation)throw new Error("API response did not include a translation");return a.translation},Ye=async(e,t,s)=>{let n=await N(e.sourceFile,"utf8"),a=await We(t,n,e.locale);await Xe(e.targetFile),await Se(e.targetFile,a,"utf8"),s.entries[K(e.sourceFile,e.locale)]={hash:e.sourceHash,updatedAt:new Date().toISOString()}},q=async(e,t)=>{je("Translate MDX content");let s=e??Ae,n=t.url||process.env.GEISTDOCS_TRANSLATE_URL||"https://geistdocs.com/translate",a=Ge(t.config??Le),r=await ze(s);r.length===0&&(h.error(`No MDX files found matching pattern: ${s}`),D("Translation cancelled"),process.exit(1)),h.info(`Found ${r.length} MDX file(s) matching pattern`),a.length===0&&(a=await Be());let i=S(process.cwd(),U),l=await He();await H(l),h.info(`Using cache: ${i}`);let c=await Me(r),{tasks:o,skippedCount:d}=qe(a,r,c,l,t.force);if(o.length===0){h.success("All translations are up to date!"),D(`Skipped ${d} file(s) (unchanged)`);return}let u=[];for(let y=0;y<o.length;y+=E)u.push(o.slice(y,y+E));h.info(`Processing ${o.length} translation(s) in ${u.length} batch(es) of up to ${E}`),d>0&&h.info(`Skipped ${d} translation(s) (unchanged)`);let f=Ue();f.start("Translating content...");let k=0;for(let y of u)await Promise.all(y.map(async L=>{await Ye(L,n,l),k+=1,f.message(`Translated ${k}/${o.length}: ${M(process.cwd(),L.targetFile)}`)})),await H(l);f.stop("Translation complete!"),D(`Created/updated ${o.length} file(s)`)};import{access as Ze,copyFile as Qe,mkdir as Z,rm as J}from"fs/promises";import{dirname as et,join as w}from"path";import{intro as tt,log as p,outro as C,spinner as Q}from"@clack/prompts";import{glob as st}from"glob";var nt=["**/*"],at=["content/docs/**"],O=".geistdocs-tmp",rt=async(e,t)=>{let s=w(e,t);await J(s,{recursive:!0,force:!0}),await Z(s,{recursive:!0})},I=async e=>await J(e,{recursive:!0,force:!0}),X=async(e,t,s)=>(await st(e,{cwd:s,nodir:!0,dot:!0,ignore:[".git/**",...t]})).sort(),it=async e=>{try{return await Ze(e),!0}catch{return!1}},ot=async(e,t,s)=>{let n=w(t,e),a=w(s,e);return await it(n)?(await Qe(n,a),{success:!0}):{success:!1,error:`Source file not found: ${n}`}},ct=async(e,t)=>{let s=w(t,e);return await J(s,{force:!0}),{success:!0}},W=20,Y=async(e,t,s)=>{let n=[];for(let a=0;a<e.length;a+=s){let r=e.slice(a,a+s),i=await Promise.all(r.map(t));n.push(...i)}return n},lt=async(e,t,s,n,a)=>{let r={success:[],deleted:[],failed:[]},i=[...new Set(e.map(c=>et(w(n,c))))];a.message(`Creating ${i.length} directories...`),await Promise.all(i.map(c=>Z(c,{recursive:!0}))),a.message(`Updating ${e.length} files...`);let l=await Y(e,async c=>{let o=await ot(c,s,n);return{file:c,...o}},W);for(let{file:c,success:o,error:d}of l)o?r.success.push(c):r.failed.push({file:c,error:d??"Unknown error"});if(t.length>0){a.message(`Deleting ${t.length} files...`);let c=await Y(t,async o=>{try{return await ct(o,n),{file:o,success:!0}}catch(d){let u=d instanceof Error?d.message:`${d}`;return{file:o,success:!1,error:u}}},W);for(let o of c)o.success?r.deleted.push(o.file):r.failed.push({file:o.file,error:o.error})}return r},pt=e=>{if(e.success.length>0){p.success(`Successfully updated ${e.success.length} files:`);for(let t of e.success)p.info(` \u2713 ${t}`)}if(e.deleted.length>0){p.success(`Deleted ${e.deleted.length} files:`);for(let t of e.deleted)p.info(` \u{1F5D1} ${t}`)}if(e.failed.length>0){p.warn(`Failed to update ${e.failed.length} files:`);for(let{file:t,error:s}of e.failed)p.error(` \u2717 ${t}: ${s}`)}},dt=e=>e.includes("canary")?"canary":"latest",gt=async e=>{let t=await fetch(`https://registry.npmjs.org/${encodeURIComponent(g)}`);if(!t.ok)throw new Error(`Failed to resolve ${g}@${e}`);let n=(await t.json())["dist-tags"]?.[e];if(!n)throw new Error(`Could not find dist-tag ${e} for ${g}`);return n},ut=async e=>{let t=await P(e),s=R(t,g);if(!s)return{currentVersion:s,nextVersion:void 0,updated:!1};let n=dt(s),a=await gt(n);return s===a?{currentVersion:s,nextVersion:a,updateTag:n,updated:!1}:(b(t,g,a),await x(e,t),{currentVersion:s,nextVersion:a,updateTag:n,updated:!0})},ft=async(e,t,s)=>{let n=await P(e);if(!V(n,g))return!1;t&&t.length>0&&p.warn("Ignoring file patterns for a package-based site. This update will bump the package version instead."),s?.sync&&p.warn("Ignoring --sync for a package-based site. Runtime updates now come from the package version.");let{currentVersion:a,nextVersion:r,updateTag:i,updated:l}=await ut(e);if(!l)return p.success(a?`@vercel/geistdocs is already at ${r} (${i}).`:"No package version update was needed."),C("Package-based site is already up to date."),!0;p.info(`Bumping ${g} from ${a} to ${r} (${i})`);let c=Q();return c.start("Installing updated package version..."),await m("pnpm",["install"],{cwd:e}),c.stop("Package update complete!"),C("Please review and test the upgraded package version."),!0},mt=async(e,t,s,n,a)=>{let r=w(e,O),i=Q(),l=a?.sync?r:t;i.start("Preparing template snapshot..."),a?.sync&&(await rt(e,O),await F(r)),i.message("Scanning for files...");let c=await X(s,n,l),o=[];if(a?.sync){i.message("Comparing with local files...");let u=await X(s,n,e),f=new Set(c);o=u.filter(k=>!f.has(k))}if(i.stop(`Found ${c.length} files to update`),c.length===0&&o.length===0){p.warn("No files matched the patterns. Nothing to update."),a?.sync&&await I(r),C("Update cancelled.");return}p.info(`Patterns: ${s.length}`),p.info(`Files to update: ${c.length}`),a?.sync&&p.info(`Files to delete: ${o.length}`),i.start("Updating files...");let d=await lt(c,o,l,e,i);a?.sync&&(i.message("Cleaning up..."),await I(r)),i.stop("Update complete!"),pt(d),C("Please review and test the changes carefully.")},ee=async(e,t)=>{let s=process.cwd(),n=j(),a=e&&e.length>0?e:nt,r=e&&e.length>0?[]:at;try{if(tt("Let's update your Geistdocs project!"),await ft(s,e,t))return;p.info("Template source: bundled package snapshot"),e&&e.length>0&&p.info(`Updating specific files: ${e.join(", ")}`),t?.sync&&p.info("Sync mode enabled: will delete files removed from template"),await mt(s,n,a,r,t)}catch(i){let l=i instanceof Error?i.message:`${i}`;try{await I(w(s,O))}catch{}p.error(`Failed to update project: ${l}`),process.exit(1)}};T.name("geistdocs").description("CLI for Geistdocs projects").version("1.19.2","-v, --version","Output the current version");T.command("init").description("Initialize a new Geistdocs project").option("--name <name>","Name of the project").option("--disable-git","Disable git initialization").action(G);T.command("update [files...]").description("Update a Geistdocs project (optionally specify files/patterns to update)").option("--sync","Delete local files that no longer exist in the template").action(ee);T.command("translate [pattern]").description("Translate MDX file(s) to one or more locales (default: content/docs/**/*.mdx)").option("--config <path>","Path to config file to load locales from (defaults to geistdocs.tsx)").option("--url <url>","Custom translation API URL (defaults to GEISTDOCS_TRANSLATE_URL or https://geistdocs.com/translate)").option("--force","Force re-translation of all files, ignoring cache").action(q);T.parse(process.argv);
|
|
3
|
+
`,"utf8")},R=(e,t)=>{for(let s of A){let n=e[s];if(n&&t in n)return n[t]}},V=(e,t)=>!!R(e,t),b=(e,t,s)=>{let n=!1;for(let a of A){let r=e[a];r&&t in r&&(r[t]=s,n=!0)}return n},j=()=>oe(new URL("../../template",import.meta.url)),F=async e=>{await ne(j(),e,{recursive:!0});let t=$(e,".gitignore"),s=$(e,"_gitignore");try{await re(s,t)}catch{}};var ye=async e=>{await F(e)},Pe=async e=>{try{return await ce(e),!0}catch{return!1}},ve=async()=>{await Pe(".env.example")&&await le(".env.example",".env.local")},Te=async e=>{let t=await P(e),s=_();return b(t,g,s)?(await x(e,t),!0):!1},ke=async e=>{await m("pnpm",["install"],{cwd:e,env:process.env,stdio:"inherit"})},$e=async e=>{await m("git",["init"],{cwd:e,env:process.env,stdio:"inherit"}),await m("git",["add","."],{cwd:e,env:process.env,stdio:"inherit"}),await m("git",["commit","-m","\u2728 Initial commit"],{cwd:e,env:process.env,stdio:"inherit"})},xe=async()=>{let e=await we({message:"What is your project named?",placeholder:"my-app",validate(t){if(t.length===0)return"Please enter a project name."}});return ue(e)&&(de("Operation cancelled."),process.exit(0)),e.toString()},G=async e=>{try{ge("Let's start a Geistdocs project!");let t=process.cwd(),s=e.name||await xe(),n=he(),a=pe(t,s);n.start("Copying bundled template..."),await ye(s),n.message("Setting up environment variables..."),process.chdir(a),await ve(),n.message("Rewriting package dependency versions..."),await Te(a),n.message("Installing dependencies..."),await ke(a),e.disableGit||(n.message("Initializing Git repository..."),await $e(a)),n.stop("Project initialized successfully!"),me("Run `pnpm dev` to start the development server.")}catch(t){let s=t instanceof Error?t.message:`Failed to initialize project: ${t}`;fe.error(s),process.exit(1)}};import{readFileSync as be,writeFileSync as Fe}from"fs";import{mkdir as De,readFile as N,writeFile as Se}from"fs/promises";import{dirname as Ce,extname as Re,relative as M,resolve as S}from"path";import{intro as je,isCancel as Ee,log as h,multiselect as Ne,outro as D,spinner as Ue}from"@clack/prompts";import{glob as Oe}from"glob";import{Node as v,Project as Ie,SyntaxKind as Je}from"ts-morph";var Le="geistdocs.tsx",Ae="content/docs/**/*.mdx",U=".translation-cache.json",E=8,B=()=>({version:1,entries:{}}),_e=async e=>{let t=await N(e),{createHash:s}=await import("crypto");return s("sha256").update(t).digest("hex")},Ve=e=>{let t=S(process.cwd(),e);return be(t,"utf8")},z=e=>v.isObjectLiteralExpression(e)?e.getProperties().flatMap(t=>{if(v.isPropertyAssignment(t)){let s=t.getNameNode();if(v.isIdentifier(s)||v.isStringLiteral(s))return[s.getText().replaceAll(/['"]/g,"")]}return[]}).filter(Boolean):[],Ge=e=>{try{let t=new Ie({compilerOptions:{allowJs:!0,jsx:4,module:99,target:10},skipAddingFilesFromTsConfig:!0,useInMemoryFileSystem:!0}),s=Ve(e),r=t.createSourceFile(e,s,{overwrite:!0}).getVariableDeclarations().find(l=>l.getName()==="translations")?.getInitializer();if(!r)return[];if(v.isObjectLiteralExpression(r))return z(r);let i=r.getFirstDescendantByKind(Je.ObjectLiteralExpression);return i?z(i):[]}catch(t){let s=t instanceof Error?t.message:`${t}`;return h.warn(`Failed to read locales from ${e}: ${s}`),[]}},Be=async()=>{let e=await Ne({message:"Which locales should be translated?",options:[{value:"cn",label:"Chinese (cn)"},{value:"jp",label:"Japanese (jp)"},{value:"es",label:"Spanish (es)"},{value:"fr",label:"French (fr)"},{value:"de",label:"German (de)"}],required:!0});return Ee(e)&&(D("Translation cancelled"),process.exit(0)),e},ze=async e=>(await Oe(e,{cwd:process.cwd(),absolute:!0,nodir:!0})).sort(),He=async()=>{let e=S(process.cwd(),U);try{let t=await N(e,"utf8"),s=JSON.parse(t);return s.version!==1||!s.entries?B():{version:1,entries:s.entries}}catch{return B()}},H=e=>{let t=S(process.cwd(),U),s=JSON.stringify(e,null,2);Fe(t,s,"utf8")},Me=async e=>{let t=await Promise.all(e.map(async s=>[s,await _e(s)]));return Object.fromEntries(t)},Ke=(e,t)=>{let s=Re(e);return`${e.slice(0,-s.length)}.${t}${s}`},K=(e,t)=>`${M(process.cwd(),e)}::${t}`,qe=(e,t,s,n,a=!1)=>{let r=[],i=0;for(let l of t){let c=s[l];for(let o of e){let d=Ke(l,o),u=K(l,o),f=n.entries[u];if(!a&&f?.hash===c){i+=1;continue}r.push({locale:o,sourceFile:l,sourceHash:c,targetFile:d})}}return{tasks:r,skippedCount:i}},Xe=async e=>{await De(Ce(e),{recursive:!0})},We=async(e,t,s)=>{let n=await fetch(e,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({content:t,locale:s})});if(!n.ok){let r=await n.text();throw new Error(`API request failed (${n.status}): ${r}`)}let a=await n.json();if(!a.translation)throw new Error("API response did not include a translation");return a.translation},Ye=async(e,t,s)=>{let n=await N(e.sourceFile,"utf8"),a=await We(t,n,e.locale);await Xe(e.targetFile),await Se(e.targetFile,a,"utf8"),s.entries[K(e.sourceFile,e.locale)]={hash:e.sourceHash,updatedAt:new Date().toISOString()}},q=async(e,t)=>{je("Translate MDX content");let s=e??Ae,n=t.url||process.env.GEISTDOCS_TRANSLATE_URL||"https://geistdocs.com/translate",a=Ge(t.config??Le),r=await ze(s);r.length===0&&(h.error(`No MDX files found matching pattern: ${s}`),D("Translation cancelled"),process.exit(1)),h.info(`Found ${r.length} MDX file(s) matching pattern`),a.length===0&&(a=await Be());let i=S(process.cwd(),U),l=await He();await H(l),h.info(`Using cache: ${i}`);let c=await Me(r),{tasks:o,skippedCount:d}=qe(a,r,c,l,t.force);if(o.length===0){h.success("All translations are up to date!"),D(`Skipped ${d} file(s) (unchanged)`);return}let u=[];for(let y=0;y<o.length;y+=E)u.push(o.slice(y,y+E));h.info(`Processing ${o.length} translation(s) in ${u.length} batch(es) of up to ${E}`),d>0&&h.info(`Skipped ${d} translation(s) (unchanged)`);let f=Ue();f.start("Translating content...");let k=0;for(let y of u)await Promise.all(y.map(async L=>{await Ye(L,n,l),k+=1,f.message(`Translated ${k}/${o.length}: ${M(process.cwd(),L.targetFile)}`)})),await H(l);f.stop("Translation complete!"),D(`Created/updated ${o.length} file(s)`)};import{access as Ze,copyFile as Qe,mkdir as Z,rm as J}from"fs/promises";import{dirname as et,join as w}from"path";import{intro as tt,log as p,outro as C,spinner as Q}from"@clack/prompts";import{glob as st}from"glob";var nt=["**/*"],at=["content/docs/**"],O=".geistdocs-tmp",rt=async(e,t)=>{let s=w(e,t);await J(s,{recursive:!0,force:!0}),await Z(s,{recursive:!0})},I=async e=>await J(e,{recursive:!0,force:!0}),X=async(e,t,s)=>(await st(e,{cwd:s,nodir:!0,dot:!0,ignore:[".git/**",...t]})).sort(),it=async e=>{try{return await Ze(e),!0}catch{return!1}},ot=async(e,t,s)=>{let n=w(t,e),a=w(s,e);return await it(n)?(await Qe(n,a),{success:!0}):{success:!1,error:`Source file not found: ${n}`}},ct=async(e,t)=>{let s=w(t,e);return await J(s,{force:!0}),{success:!0}},W=20,Y=async(e,t,s)=>{let n=[];for(let a=0;a<e.length;a+=s){let r=e.slice(a,a+s),i=await Promise.all(r.map(t));n.push(...i)}return n},lt=async(e,t,s,n,a)=>{let r={success:[],deleted:[],failed:[]},i=[...new Set(e.map(c=>et(w(n,c))))];a.message(`Creating ${i.length} directories...`),await Promise.all(i.map(c=>Z(c,{recursive:!0}))),a.message(`Updating ${e.length} files...`);let l=await Y(e,async c=>{let o=await ot(c,s,n);return{file:c,...o}},W);for(let{file:c,success:o,error:d}of l)o?r.success.push(c):r.failed.push({file:c,error:d??"Unknown error"});if(t.length>0){a.message(`Deleting ${t.length} files...`);let c=await Y(t,async o=>{try{return await ct(o,n),{file:o,success:!0}}catch(d){let u=d instanceof Error?d.message:`${d}`;return{file:o,success:!1,error:u}}},W);for(let o of c)o.success?r.deleted.push(o.file):r.failed.push({file:o.file,error:o.error})}return r},pt=e=>{if(e.success.length>0){p.success(`Successfully updated ${e.success.length} files:`);for(let t of e.success)p.info(` \u2713 ${t}`)}if(e.deleted.length>0){p.success(`Deleted ${e.deleted.length} files:`);for(let t of e.deleted)p.info(` \u{1F5D1} ${t}`)}if(e.failed.length>0){p.warn(`Failed to update ${e.failed.length} files:`);for(let{file:t,error:s}of e.failed)p.error(` \u2717 ${t}: ${s}`)}},dt=e=>e.includes("canary")?"canary":"latest",gt=async e=>{let t=await fetch(`https://registry.npmjs.org/${encodeURIComponent(g)}`);if(!t.ok)throw new Error(`Failed to resolve ${g}@${e}`);let n=(await t.json())["dist-tags"]?.[e];if(!n)throw new Error(`Could not find dist-tag ${e} for ${g}`);return n},ut=async e=>{let t=await P(e),s=R(t,g);if(!s)return{currentVersion:s,nextVersion:void 0,updated:!1};let n=dt(s),a=await gt(n);return s===a?{currentVersion:s,nextVersion:a,updateTag:n,updated:!1}:(b(t,g,a),await x(e,t),{currentVersion:s,nextVersion:a,updateTag:n,updated:!0})},ft=async(e,t,s)=>{let n=await P(e);if(!V(n,g))return!1;t&&t.length>0&&p.warn("Ignoring file patterns for a package-based site. This update will bump the package version instead."),s?.sync&&p.warn("Ignoring --sync for a package-based site. Runtime updates now come from the package version.");let{currentVersion:a,nextVersion:r,updateTag:i,updated:l}=await ut(e);if(!l)return p.success(a?`@vercel/geistdocs is already at ${r} (${i}).`:"No package version update was needed."),C("Package-based site is already up to date."),!0;p.info(`Bumping ${g} from ${a} to ${r} (${i})`);let c=Q();return c.start("Installing updated package version..."),await m("pnpm",["install"],{cwd:e}),c.stop("Package update complete!"),C("Please review and test the upgraded package version."),!0},mt=async(e,t,s,n,a)=>{let r=w(e,O),i=Q(),l=a?.sync?r:t;i.start("Preparing template snapshot..."),a?.sync&&(await rt(e,O),await F(r)),i.message("Scanning for files...");let c=await X(s,n,l),o=[];if(a?.sync){i.message("Comparing with local files...");let u=await X(s,n,e),f=new Set(c);o=u.filter(k=>!f.has(k))}if(i.stop(`Found ${c.length} files to update`),c.length===0&&o.length===0){p.warn("No files matched the patterns. Nothing to update."),a?.sync&&await I(r),C("Update cancelled.");return}p.info(`Patterns: ${s.length}`),p.info(`Files to update: ${c.length}`),a?.sync&&p.info(`Files to delete: ${o.length}`),i.start("Updating files...");let d=await lt(c,o,l,e,i);a?.sync&&(i.message("Cleaning up..."),await I(r)),i.stop("Update complete!"),pt(d),C("Please review and test the changes carefully.")},ee=async(e,t)=>{let s=process.cwd(),n=j(),a=e&&e.length>0?e:nt,r=e&&e.length>0?[]:at;try{if(tt("Let's update your Geistdocs project!"),await ft(s,e,t))return;p.info("Template source: bundled package snapshot"),e&&e.length>0&&p.info(`Updating specific files: ${e.join(", ")}`),t?.sync&&p.info("Sync mode enabled: will delete files removed from template"),await mt(s,n,a,r,t)}catch(i){let l=i instanceof Error?i.message:`${i}`;try{await I(w(s,O))}catch{}p.error(`Failed to update project: ${l}`),process.exit(1)}};T.name("geistdocs").description("CLI for Geistdocs projects").version("1.19.4","-v, --version","Output the current version");T.command("init").description("Initialize a new Geistdocs project").option("--name <name>","Name of the project").option("--disable-git","Disable git initialization").action(G);T.command("update [files...]").description("Update a Geistdocs project (optionally specify files/patterns to update)").option("--sync","Delete local files that no longer exist in the template").action(ee);T.command("translate [pattern]").description("Translate MDX file(s) to one or more locales (default: content/docs/**/*.mdx)").option("--config <path>","Path to config file to load locales from (defaults to geistdocs.tsx)").option("--url <url>","Custom translation API URL (defaults to GEISTDOCS_TRANSLATE_URL or https://geistdocs.com/translate)").option("--force","Force re-translation of all files, ignoring cache").action(q);T.parse(process.argv);
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface ResolvePageMarkdownUrlOptions {
|
|
2
|
+
basePath?: string;
|
|
3
|
+
isRootMountedPage?: boolean;
|
|
4
|
+
pageUrl: string;
|
|
5
|
+
publicPageUrl?: string;
|
|
6
|
+
}
|
|
7
|
+
export declare const resolvePageMarkdownUrl: ({ basePath, pageUrl, isRootMountedPage, publicPageUrl, }: ResolvePageMarkdownUrlOptions) => string;
|
|
8
|
+
//# sourceMappingURL=markdown-url.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown-url.d.ts","sourceRoot":"","sources":["../../src/internal/markdown-url.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,sBAAsB,GAAI,0DAKpC,6BAA6B,WAW/B,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { getPublicPath } from "../config.js";
|
|
2
|
+
const TRAILING_SLASH_PATTERN = /\/$/;
|
|
3
|
+
export const resolvePageMarkdownUrl = ({ basePath, pageUrl, isRootMountedPage = pageUrl === "/", publicPageUrl = getPublicPath(pageUrl, basePath), }) => {
|
|
4
|
+
const normalizedPublicPageUrl = publicPageUrl.replace(TRAILING_SLASH_PATTERN, "");
|
|
5
|
+
if (isRootMountedPage) {
|
|
6
|
+
return `${normalizedPublicPageUrl}/index.md`;
|
|
7
|
+
}
|
|
8
|
+
return `${normalizedPublicPageUrl}.md`;
|
|
9
|
+
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"navbar-logo.d.ts","sourceRoot":"","sources":["../../../src/internal/navbar/navbar-logo.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAC;AAK5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAY9D,eAAO,MAAM,mBAAmB,gBAAgB,CAAC;AAEjD,eAAO,MAAM,oBAAoB,EAAE,yBAAyB,EAiF3D,CAAC;AAgGF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,SAAS,EACjD,aAAa,EAAE,MAAM,GAAG,SAAS,GAChC,yBAAyB,EAAE,CAI7B;AAED,KAAK,eAAe,GAAG;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,CACA;IACE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,KAAK,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAC3C,GACD;IACE,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;CACjB,CACJ,CAAC;AAEF,wBAAgB,UAAU,CAAC,EACzB,SAAS,EACT,IAAU,EACV,GAAG,KAAK,EACT,EAAE,eAAe,
|
|
1
|
+
{"version":3,"file":"navbar-logo.d.ts","sourceRoot":"","sources":["../../../src/internal/navbar/navbar-logo.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAC;AAK5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAY9D,eAAO,MAAM,mBAAmB,gBAAgB,CAAC;AAEjD,eAAO,MAAM,oBAAoB,EAAE,yBAAyB,EAiF3D,CAAC;AAgGF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,SAAS,EACjD,aAAa,EAAE,MAAM,GAAG,SAAS,GAChC,yBAAyB,EAAE,CAI7B;AAED,KAAK,eAAe,GAAG;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,CACA;IACE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,KAAK,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,yBAAyB,EAAE,CAAC;CAC3C,GACD;IACE,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC;CACjB,CACJ,CAAC;AAEF,wBAAgB,UAAU,CAAC,EACzB,SAAS,EACT,IAAU,EACV,GAAG,KAAK,EACT,EAAE,eAAe,2CAsIjB"}
|
|
@@ -143,9 +143,7 @@ export function NavbarLogo({ className, href = "/", ...props }) {
|
|
|
143
143
|
router.prefetch(href);
|
|
144
144
|
}
|
|
145
145
|
}, [isOss, router, href]);
|
|
146
|
-
return (_jsxs("span", { className: cn("flex items-center gap-2.5", className), children: [_jsx(Link, { className: "-mx-2 flex items-center rounded-md p-2 text-gray-1000 outline-none focus-visible:ring-2 focus-visible:ring-blue-700 focus-visible:ring-inset", href: isOss ? "https://vercel.com/oss" : "https://vercel.com/", rel: "noopener", target: "_blank", children: isOss ? (_jsxs(_Fragment, { children: [_jsx(LogoIconVercel, { className: "@min-[640px]:hidden", size: 18 }), _jsx(LogoVercelOss, { className: "@min-[640px]:block hidden shrink-0",
|
|
147
|
-
// to exactly match vercel.com's triangle
|
|
148
|
-
size: (18 * 45) / 43.391_652 })] })) : (_jsx(LogoIconVercel, { size: 18 })) }), _jsx("div", { className: "w-5 text-center text-gray-alpha-400 text-lg dark:text-gray-600", children: _jsx(IconSlashForward, { size: 20 }) }), isOss ? (_jsxs(_Fragment, { children: [_jsx(Link, { className: "flex @min-[1024px]:hidden items-center text-gray-1000", href: href, children: props.logo }), _jsxs("div", { className: "@min-[1024px]:contents hidden", children: [_jsx(NavigationMenu, { delayDuration: 0, onValueChange: (value) => setNavOpen(Boolean(value)), skipDelayDuration: 0, viewport: false, children: _jsx(NavigationMenuList, { className: "h-16 items-stretch", children: _jsxs(NavigationMenuItem, { className: "flex h-full items-center", children: [_jsx(NavigationMenuTrigger, { className: "relative -mx-3 flex h-full items-center gap-1.5 px-3 text-gray-1000 outline-none before:absolute before:inset-x-0 before:top-1/2 before:h-9 before:-translate-y-1/2 before:rounded-md before:content-[''] focus-visible:before:ring-2 focus-visible:before:ring-blue-700 focus-visible:before:ring-inset", onClick: (e) => {
|
|
146
|
+
return (_jsxs("span", { className: cn("flex items-center gap-2.5", className), children: [_jsx(Link, { className: "-mx-2 flex items-center rounded-md p-2 text-gray-1000 outline-none focus-visible:ring-2 focus-visible:ring-blue-700 focus-visible:ring-inset", href: isOss ? "https://vercel.com/oss" : "https://vercel.com/", rel: "noopener", target: "_blank", children: isOss ? (_jsxs(_Fragment, { children: [_jsx(LogoIconVercel, { className: "@min-[640px]:hidden", size: 18 }), _jsx(LogoVercelOss, { className: "@min-[640px]:block hidden shrink-0", size: 18 })] })) : (_jsx(LogoIconVercel, { size: 18 })) }), _jsx("div", { className: "w-5 text-center text-gray-alpha-400 text-lg dark:text-gray-600", children: _jsx(IconSlashForward, { size: 20 }) }), isOss ? (_jsxs(_Fragment, { children: [_jsx(Link, { className: "flex @min-[1024px]:hidden items-center text-gray-1000", href: href, children: props.logo }), _jsxs("div", { className: "@min-[1024px]:contents hidden", children: [_jsx(NavigationMenu, { delayDuration: 0, onValueChange: (value) => setNavOpen(Boolean(value)), skipDelayDuration: 0, viewport: false, children: _jsx(NavigationMenuList, { className: "h-16 items-stretch", children: _jsxs(NavigationMenuItem, { className: "flex h-full items-center", children: [_jsx(NavigationMenuTrigger, { className: "relative -mx-3 flex h-full items-center gap-1.5 px-3 text-gray-1000 outline-none before:absolute before:inset-x-0 before:top-1/2 before:h-9 before:-translate-y-1/2 before:rounded-md before:content-[''] focus-visible:before:ring-2 focus-visible:before:ring-blue-700 focus-visible:before:ring-inset", onClick: (e) => {
|
|
149
147
|
if (e.detail !== 0) {
|
|
150
148
|
router.push(href);
|
|
151
149
|
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface SmartNotFoundPage {
|
|
2
|
+
description?: string;
|
|
3
|
+
keywords?: string[];
|
|
4
|
+
path: string;
|
|
5
|
+
scope?: string;
|
|
6
|
+
title: string;
|
|
7
|
+
url: string;
|
|
8
|
+
}
|
|
9
|
+
export interface SmartNotFoundSuggestion {
|
|
10
|
+
description?: string;
|
|
11
|
+
title: string;
|
|
12
|
+
url: string;
|
|
13
|
+
}
|
|
14
|
+
export declare const findSmartNotFoundSuggestions: (query: string, pages: SmartNotFoundPage[], { limit, minScore }?: {
|
|
15
|
+
limit?: number;
|
|
16
|
+
minScore?: number;
|
|
17
|
+
}) => SmartNotFoundSuggestion[];
|
|
18
|
+
export declare const renderSmartNotFoundMarkdown: ({ allPagesUrl, requestedPath, suggestions, }: {
|
|
19
|
+
allPagesUrl: string;
|
|
20
|
+
requestedPath: string;
|
|
21
|
+
suggestions: SmartNotFoundSuggestion[];
|
|
22
|
+
}) => string;
|
|
23
|
+
//# sourceMappingURL=smart-not-found.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"smart-not-found.d.ts","sourceRoot":"","sources":["../../src/internal/smart-not-found.ts"],"names":[],"mappings":"AAUA,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAwND,eAAO,MAAM,4BAA4B,GACvC,OAAO,MAAM,EACb,OAAO,iBAAiB,EAAE,EAC1B,sBAAgC;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,KACzE,uBAAuB,EAwCzB,CAAC;AAEF,eAAO,MAAM,2BAA2B,GAAI,8CAIzC;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,uBAAuB,EAAE,CAAC;CACxC,WA2BA,CAAC"}
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
const MARKDOWN_EXTENSION_PATTERN = /\.mdx?$/;
|
|
2
|
+
const NON_ALPHANUMERIC_PATTERN = /[^\p{L}\p{N}]+/gu;
|
|
3
|
+
const WHITESPACE_PATTERN = /\s+/g;
|
|
4
|
+
const MARKDOWN_LINK_PATTERN = /!?\[([^\]]*)\]\([^)]*\)/g;
|
|
5
|
+
const MARKDOWN_MARKER_PATTERN = /[`*_~#>|]/g;
|
|
6
|
+
const MAX_NORMALIZED_LENGTH = 512;
|
|
7
|
+
const MAX_TOKEN_LENGTH = 48;
|
|
8
|
+
const MAX_CANDIDATE_TOKENS = 24;
|
|
9
|
+
const MAX_QUERY_TOKENS = 16;
|
|
10
|
+
const decodePath = (value) => {
|
|
11
|
+
try {
|
|
12
|
+
return decodeURIComponent(value);
|
|
13
|
+
}
|
|
14
|
+
catch {
|
|
15
|
+
return value;
|
|
16
|
+
}
|
|
17
|
+
};
|
|
18
|
+
const normalize = (value) => decodePath(value.slice(0, MAX_NORMALIZED_LENGTH))
|
|
19
|
+
.normalize("NFKD")
|
|
20
|
+
.replace(MARKDOWN_EXTENSION_PATTERN, "")
|
|
21
|
+
.toLocaleLowerCase()
|
|
22
|
+
.replace(NON_ALPHANUMERIC_PATTERN, " ")
|
|
23
|
+
.trim();
|
|
24
|
+
const tokenize = (value, limit = MAX_CANDIDATE_TOKENS) => normalize(value)
|
|
25
|
+
.split(" ")
|
|
26
|
+
.filter(Boolean)
|
|
27
|
+
.slice(-limit)
|
|
28
|
+
.map((token) => token.slice(0, MAX_TOKEN_LENGTH));
|
|
29
|
+
const tokenizePathQuery = (value) => {
|
|
30
|
+
const segments = decodePath(value.slice(0, MAX_NORMALIZED_LENGTH))
|
|
31
|
+
.split("/")
|
|
32
|
+
.filter(Boolean)
|
|
33
|
+
.slice(-3);
|
|
34
|
+
const pathTokens = segments.flatMap((segment) => tokenize(segment, 8));
|
|
35
|
+
const finalSegmentTokens = tokenize(segments.at(-1) ?? "", 8);
|
|
36
|
+
return [...pathTokens, ...finalSegmentTokens].slice(-MAX_QUERY_TOKENS);
|
|
37
|
+
};
|
|
38
|
+
const editDistance = (left, right) => {
|
|
39
|
+
if (left === right) {
|
|
40
|
+
return 0;
|
|
41
|
+
}
|
|
42
|
+
const rowWord = left.length >= right.length ? left : right;
|
|
43
|
+
const columnWord = left.length >= right.length ? right : left;
|
|
44
|
+
let previousPrevious;
|
|
45
|
+
let previous = Array.from({ length: columnWord.length + 1 }, (_, index) => index);
|
|
46
|
+
for (let rowIndex = 1; rowIndex <= rowWord.length; rowIndex += 1) {
|
|
47
|
+
const current = [rowIndex];
|
|
48
|
+
for (let columnIndex = 1; columnIndex <= columnWord.length; columnIndex += 1) {
|
|
49
|
+
const substitutionCost = rowWord[rowIndex - 1] === columnWord[columnIndex - 1] ? 0 : 1;
|
|
50
|
+
current[columnIndex] = Math.min(previous[columnIndex] + 1, current[columnIndex - 1] + 1, previous[columnIndex - 1] + substitutionCost);
|
|
51
|
+
if (previousPrevious &&
|
|
52
|
+
rowIndex > 1 &&
|
|
53
|
+
columnIndex > 1 &&
|
|
54
|
+
rowWord[rowIndex - 1] === columnWord[columnIndex - 2] &&
|
|
55
|
+
rowWord[rowIndex - 2] === columnWord[columnIndex - 1]) {
|
|
56
|
+
current[columnIndex] = Math.min(current[columnIndex], previousPrevious[columnIndex - 2] + 1);
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
previousPrevious = previous;
|
|
60
|
+
previous = current;
|
|
61
|
+
}
|
|
62
|
+
return previous[columnWord.length];
|
|
63
|
+
};
|
|
64
|
+
const tokenSimilarity = (query, candidate) => {
|
|
65
|
+
if (query === candidate) {
|
|
66
|
+
return 1;
|
|
67
|
+
}
|
|
68
|
+
if (Math.min(query.length, candidate.length) >= 3 &&
|
|
69
|
+
(query.startsWith(candidate) || candidate.startsWith(query))) {
|
|
70
|
+
return 0.92;
|
|
71
|
+
}
|
|
72
|
+
if (Math.abs(query.length - candidate.length) > 4) {
|
|
73
|
+
return 0;
|
|
74
|
+
}
|
|
75
|
+
return (1 -
|
|
76
|
+
editDistance(query, candidate) / Math.max(query.length, candidate.length));
|
|
77
|
+
};
|
|
78
|
+
const tokenCoverage = (query, candidate) => {
|
|
79
|
+
if (query.length === 0 || candidate.length === 0) {
|
|
80
|
+
return 0;
|
|
81
|
+
}
|
|
82
|
+
return (query.reduce((total, queryToken) => {
|
|
83
|
+
const bestMatch = candidate.reduce((best, candidateToken) => Math.max(best, tokenSimilarity(queryToken, candidateToken)), 0);
|
|
84
|
+
return total + bestMatch;
|
|
85
|
+
}, 0) / query.length);
|
|
86
|
+
};
|
|
87
|
+
const bigrams = (value) => {
|
|
88
|
+
const compact = normalize(value).replace(WHITESPACE_PATTERN, "");
|
|
89
|
+
const pairs = new Map();
|
|
90
|
+
for (let index = 0; index < compact.length - 1; index += 1) {
|
|
91
|
+
const pair = compact.slice(index, index + 2);
|
|
92
|
+
pairs.set(pair, (pairs.get(pair) ?? 0) + 1);
|
|
93
|
+
}
|
|
94
|
+
return pairs;
|
|
95
|
+
};
|
|
96
|
+
const diceCoefficient = (left, right) => {
|
|
97
|
+
const leftPairs = bigrams(left);
|
|
98
|
+
const rightPairs = bigrams(right);
|
|
99
|
+
const leftSize = Array.from(leftPairs.values()).reduce((total, count) => total + count, 0);
|
|
100
|
+
const rightSize = Array.from(rightPairs.values()).reduce((total, count) => total + count, 0);
|
|
101
|
+
if (leftSize === 0 || rightSize === 0) {
|
|
102
|
+
return normalize(left) === normalize(right) ? 1 : 0;
|
|
103
|
+
}
|
|
104
|
+
let overlap = 0;
|
|
105
|
+
for (const [pair, count] of leftPairs) {
|
|
106
|
+
overlap += Math.min(count, rightPairs.get(pair) ?? 0);
|
|
107
|
+
}
|
|
108
|
+
return (2 * overlap) / (leftSize + rightSize);
|
|
109
|
+
};
|
|
110
|
+
const scorePage = (query, page) => {
|
|
111
|
+
const queryTokens = tokenizePathQuery(query);
|
|
112
|
+
const pathTokens = tokenize(page.path);
|
|
113
|
+
const titleTokens = tokenize(page.title, 16);
|
|
114
|
+
const keywordTokens = tokenize(page.keywords?.join(" ") ?? "", 16);
|
|
115
|
+
const pathCoverage = tokenCoverage(queryTokens, pathTokens);
|
|
116
|
+
const titleCoverage = tokenCoverage(queryTokens, titleTokens);
|
|
117
|
+
const keywordCoverage = tokenCoverage(queryTokens, keywordTokens);
|
|
118
|
+
const characterSimilarity = Math.max(diceCoefficient(query, page.path), diceCoefficient(query, page.title));
|
|
119
|
+
const queryDepth = decodePath(query).split("/").filter(Boolean).length;
|
|
120
|
+
const pathDepth = decodePath(page.path).split("/").filter(Boolean).length;
|
|
121
|
+
const depthPenalty = Math.max(0, pathDepth - queryDepth) * 0.05;
|
|
122
|
+
return (pathCoverage * 0.45 +
|
|
123
|
+
titleCoverage * 0.3 +
|
|
124
|
+
characterSimilarity * 0.2 +
|
|
125
|
+
keywordCoverage * 0.05 -
|
|
126
|
+
depthPenalty);
|
|
127
|
+
};
|
|
128
|
+
const cleanText = (value) => value
|
|
129
|
+
.slice(0, 1000)
|
|
130
|
+
.replace(MARKDOWN_LINK_PATTERN, "$1")
|
|
131
|
+
.replace(MARKDOWN_MARKER_PATTERN, "")
|
|
132
|
+
.replace(WHITESPACE_PATTERN, " ")
|
|
133
|
+
.trim();
|
|
134
|
+
const truncateAtWord = (value, maxLength) => {
|
|
135
|
+
if (value.length <= maxLength) {
|
|
136
|
+
return value;
|
|
137
|
+
}
|
|
138
|
+
const truncated = value.slice(0, maxLength);
|
|
139
|
+
const lastSpace = truncated.lastIndexOf(" ");
|
|
140
|
+
return lastSpace > maxLength / 2 ? truncated.slice(0, lastSpace) : truncated;
|
|
141
|
+
};
|
|
142
|
+
const escapeMarkdownLabel = (value) => value.replace(/([\\[\]])/g, "\\$1");
|
|
143
|
+
const escapeInlineCode = (value) => [...value]
|
|
144
|
+
.map((character) => {
|
|
145
|
+
const codePoint = character.charCodeAt(0);
|
|
146
|
+
return codePoint <= 31 || codePoint === 127 || character === "`"
|
|
147
|
+
? `%${codePoint.toString(16).padStart(2, "0").toUpperCase()}`
|
|
148
|
+
: character;
|
|
149
|
+
})
|
|
150
|
+
.join("");
|
|
151
|
+
export const findSmartNotFoundSuggestions = (query, pages, { limit = 5, minScore = 0.38 } = {}) => {
|
|
152
|
+
const normalizedLimit = Number.isFinite(limit)
|
|
153
|
+
? Math.max(0, Math.floor(limit))
|
|
154
|
+
: 5;
|
|
155
|
+
const normalizedMinScore = Number.isFinite(minScore) ? minScore : 0.38;
|
|
156
|
+
if (normalizedLimit === 0) {
|
|
157
|
+
return [];
|
|
158
|
+
}
|
|
159
|
+
const ranked = pages
|
|
160
|
+
.map((page) => ({ page, score: scorePage(query, page) }))
|
|
161
|
+
.filter(({ score }) => score >= normalizedMinScore)
|
|
162
|
+
.sort((left, right) => right.score - left.score || left.page.url.localeCompare(right.page.url));
|
|
163
|
+
const suggestions = [];
|
|
164
|
+
const seen = new Set();
|
|
165
|
+
for (const { page } of ranked) {
|
|
166
|
+
if (seen.has(page.url)) {
|
|
167
|
+
continue;
|
|
168
|
+
}
|
|
169
|
+
seen.add(page.url);
|
|
170
|
+
suggestions.push({
|
|
171
|
+
title: cleanText(page.title),
|
|
172
|
+
url: page.url,
|
|
173
|
+
description: page.description
|
|
174
|
+
? truncateAtWord(cleanText(page.description), 150)
|
|
175
|
+
: undefined,
|
|
176
|
+
});
|
|
177
|
+
if (suggestions.length === normalizedLimit) {
|
|
178
|
+
break;
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
return suggestions;
|
|
182
|
+
};
|
|
183
|
+
export const renderSmartNotFoundMarkdown = ({ allPagesUrl, requestedPath, suggestions, }) => {
|
|
184
|
+
const displayPath = escapeInlineCode(requestedPath);
|
|
185
|
+
if (suggestions.length === 0) {
|
|
186
|
+
return `# Page Not Found
|
|
187
|
+
|
|
188
|
+
\`${displayPath}\` does not exist.
|
|
189
|
+
|
|
190
|
+
Browse all pages: [${allPagesUrl}](${allPagesUrl})
|
|
191
|
+
`;
|
|
192
|
+
}
|
|
193
|
+
const suggestionLines = suggestions
|
|
194
|
+
.map(({ description, title, url }) => {
|
|
195
|
+
const summary = description ? `: ${description}` : "";
|
|
196
|
+
return `- [${escapeMarkdownLabel(title)}](${url})${summary}`;
|
|
197
|
+
})
|
|
198
|
+
.join("\n");
|
|
199
|
+
return `# Page Not Found
|
|
200
|
+
|
|
201
|
+
\`${displayPath}\` does not exist. Similar pages:
|
|
202
|
+
|
|
203
|
+
${suggestionLines}
|
|
204
|
+
|
|
205
|
+
All pages: [${allPagesUrl}](${allPagesUrl})
|
|
206
|
+
`;
|
|
207
|
+
};
|
package/dist/pages/docs.d.ts
CHANGED
|
@@ -39,7 +39,7 @@ export interface ResolvePageMarkdownUrlOptions {
|
|
|
39
39
|
pageUrl: string;
|
|
40
40
|
publicPageUrl?: string;
|
|
41
41
|
}
|
|
42
|
-
export declare const resolvePageMarkdownUrl: (
|
|
42
|
+
export declare const resolvePageMarkdownUrl: (options: ResolvePageMarkdownUrlOptions) => string;
|
|
43
43
|
interface DocsPageData extends GeistdocsPageVisibilityData {
|
|
44
44
|
body: ComponentType<{
|
|
45
45
|
components?: MDXComponents;
|
package/dist/pages/docs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EAAE,KAAK,eAAe,EAA+B,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/pages/docs.tsx"],"names":[],"mappings":"AAAA,OAAO,EAGL,QAAQ,IAAI,gBAAgB,EAE7B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACtE,OAAO,EAAE,KAAK,eAAe,EAA+B,MAAM,WAAW,CAAC;AAW9E,OAAO,EACL,KAAK,2BAA2B,EAEjC,MAAM,6BAA6B,CAAC;AAGrC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAC1C,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAChF,KAAK,iBAAiB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC9D,KAAK,YAAY,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;AACvC,KAAK,qBAAqB,GAAG,WAAW,CACtC,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAC,gBAAgB,CAAC,CAC1D,CAAC;AACF,UAAU,cAAc;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,KAAK,WAAW,GACZ,aAAa,GACb,CAAC,CAAC,OAAO,EAAE;IACT,IAAI,EAAE,YAAY,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB,KAAK,aAAa,CAAC,CAAC;AAEzB,KAAK,eAAe,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AAEpE,UAAU,wBAAwB;IAChC,MAAM,CAAC,EAAE,OAAO,GAAG,eAAe,CAAC;CACpC;AAED,UAAU,cAAc;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,UAAU,oBAAqB,SAAQ,cAAc;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,kBAAmB,SAAQ,oBAAoB;IACvD,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,sBAAsB,GACjC,SAAS,6BAA6B,WACI,CAAC;AAE7C,UAAU,YAAa,SAAQ,2BAA2B;IACxD,IAAI,EAAE,aAAa,CAAC;QAAE,UAAU,CAAC,EAAE,aAAa,CAAA;KAAE,CAAC,CAAC;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,cAAc,CAAC,OAAO,gBAAgB,CAAC,CAAC,KAAK,CAAC,CAAC;CACrD;AAED,UAAU,qBAAqB;IAC7B,MAAM,EAAE,IAAI,CACV,eAAe,EACf,IAAI,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,aAAa,GAAG,QAAQ,CACrE,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC;IACzD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,KAAK,MAAM,CAAC;IACzD,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,MAAM,CAAC;IACjD,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,MAAM,CAAC;IAC7D,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE;QACnB,QAAQ,EAAE,QAAQ,CAAC;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,cAAc,CAAC;KACxB,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,wBAAwB,CAAC;IACrC,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE;QACpB,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,EAAE,aAAa,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,EAAE,MAAM,CAAC;KACvB,KAAK,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE;QACtB,IAAI,EAAE,YAAY,CAAC;QACnB,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,YAAY,CAAC;KACtB,KAAK,YAAY,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,qBAAqB,CAAC,EAAE,cAAc,CACpC,OAAO,gBAAgB,CACxB,CAAC,uBAAuB,CAAC,CAAC;CAC5B;AA+BD,eAAO,MAAM,cAAc,GAAI,6LAe5B,qBAAqB;wBAoBnB;QACD,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;KACpD;;oCA2KE;QACD,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAC;KACpD,KAAG,OAAO,CAAC,QAAQ,CAAC;CAiDtB,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;CAA4B,CAAC"}
|
package/dist/pages/docs.js
CHANGED
|
@@ -5,6 +5,7 @@ import { notFound } from "next/navigation";
|
|
|
5
5
|
import { getPublicPath, withBasePath } from "../config";
|
|
6
6
|
import { cn } from "../internal/cn";
|
|
7
7
|
import { resolveDocumentTitle } from "../internal/document-title";
|
|
8
|
+
import { resolvePageMarkdownUrl as resolveInternalPageMarkdownUrl } from "../internal/markdown-url.js";
|
|
8
9
|
import { createPageActions as createInternalPageActions } from "../internal/page-actions";
|
|
9
10
|
import { GeistdocsPageActions, GeistdocsTableOfContentsActions, } from "../internal/page-actions-client";
|
|
10
11
|
import { PageBreadcrumb } from "../internal/page-breadcrumb";
|
|
@@ -12,14 +13,7 @@ import { getPageFooterItems, PageFooter } from "../internal/page-footer";
|
|
|
12
13
|
import { getPageRobots, } from "../internal/page-visibility";
|
|
13
14
|
import { GeistdocsTableOfContents } from "../internal/table-of-contents";
|
|
14
15
|
import { createMdxComponents } from "../mdx";
|
|
15
|
-
const
|
|
16
|
-
export const resolvePageMarkdownUrl = ({ basePath, pageUrl, isRootMountedPage = pageUrl === "/", publicPageUrl = getPublicPath(pageUrl, basePath), }) => {
|
|
17
|
-
const normalizedPublicPageUrl = publicPageUrl.replace(TRAILING_SLASH_PATTERN, "");
|
|
18
|
-
if (isRootMountedPage) {
|
|
19
|
-
return `${normalizedPublicPageUrl}/index.md`;
|
|
20
|
-
}
|
|
21
|
-
return `${normalizedPublicPageUrl}.md`;
|
|
22
|
-
};
|
|
16
|
+
export const resolvePageMarkdownUrl = (options) => resolveInternalPageMarkdownUrl(options);
|
|
23
17
|
const DocsTitle = ({ className, ...props }) => (_jsx(FumadocsDocsTitle, { className: cn("mb-4 text-balance", className), ...props }));
|
|
24
18
|
const DocsDescription = (props) => _jsx(FumadocsDocsDescription, { ...props });
|
|
25
19
|
const DocsBody = ({ className, ...props }) => (_jsx(FumadocsDocsBody, { className: cn("mx-auto w-full", className), ...props }));
|
|
@@ -32,7 +26,7 @@ export const createDocsPage = ({ config, source, mdx, pageActions = createIntern
|
|
|
32
26
|
const publicPageUrl = getPublicPageUrl?.({ page, params, pageUrl }) ??
|
|
33
27
|
getPublicPath(pageUrl, config.basePath);
|
|
34
28
|
const markdownUrl = getMarkdownUrl?.({ page, params, pageUrl, publicPageUrl }) ??
|
|
35
|
-
|
|
29
|
+
resolveInternalPageMarkdownUrl({
|
|
36
30
|
basePath: config.basePath,
|
|
37
31
|
isRootMountedPage: source.baseUrl === "/" && page.slugs.length === 0,
|
|
38
32
|
pageUrl,
|
package/dist/routes/llms.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { NextRequest } from "next/server";
|
|
2
|
-
import type
|
|
2
|
+
import { type GeistdocsConfig } from "../config.js";
|
|
3
|
+
import type { GeistdocsSourceBundle } from "../source.js";
|
|
3
4
|
type SourceBundle = GeistdocsSourceBundle;
|
|
4
5
|
type GeistdocsPage = NonNullable<ReturnType<SourceBundle["source"]["getPage"]>>;
|
|
5
6
|
interface DocsMarkdownParams {
|
|
@@ -28,14 +29,39 @@ export declare const createLlmsRoute: ({ filterPage, source, sources, transform,
|
|
|
28
29
|
}) => Promise<Response>;
|
|
29
30
|
revalidate: false;
|
|
30
31
|
};
|
|
31
|
-
interface CreateDocsMarkdownRouteOptions {
|
|
32
|
+
export interface CreateDocsMarkdownRouteOptions {
|
|
33
|
+
config?: Pick<GeistdocsConfig, "basePath" | "defaultLanguage" | "translations">;
|
|
32
34
|
filterStaticParams?: (params: DocsMarkdownParams) => boolean;
|
|
35
|
+
/** Enable an agent-readable Markdown response for missing pages. */
|
|
36
|
+
notFound?: false | MarkdownNotFoundOptions;
|
|
33
37
|
source?: SourceBundle;
|
|
34
38
|
sources?: SourceBundle[];
|
|
35
39
|
transform?: MarkdownTransform;
|
|
36
40
|
}
|
|
37
|
-
export
|
|
38
|
-
|
|
41
|
+
export interface MarkdownNotFoundOptions {
|
|
42
|
+
/** Map a source page to its app-local Markdown URL. */
|
|
43
|
+
getPageMarkdownUrl?: (context: {
|
|
44
|
+
lang: string;
|
|
45
|
+
page: GeistdocsPage;
|
|
46
|
+
source: SourceBundle;
|
|
47
|
+
}) => string;
|
|
48
|
+
/**
|
|
49
|
+
* Reconstruct the app-local public path from the Markdown route slug. The
|
|
50
|
+
* path also scopes page lookup when multiple sources share this route.
|
|
51
|
+
*/
|
|
52
|
+
getRequestedPath?: (context: {
|
|
53
|
+
lang: string;
|
|
54
|
+
slug: string[];
|
|
55
|
+
}) => string;
|
|
56
|
+
/** Maximum suggestions to return. Defaults to 5. */
|
|
57
|
+
maxSuggestions?: number;
|
|
58
|
+
/** Minimum fuzzy-match score from 0 to 1. Defaults to 0.38. */
|
|
59
|
+
minScore?: number;
|
|
60
|
+
/** HTTP status for the useful not-found body. Defaults to 200. */
|
|
61
|
+
status?: 200 | 404;
|
|
62
|
+
}
|
|
63
|
+
export declare const createDocsMarkdownRoute: ({ config, filterStaticParams, notFound: notFoundOptions, source, sources, transform, }: CreateDocsMarkdownRouteOptions) => {
|
|
64
|
+
GET: (_request: Request, { params }: {
|
|
39
65
|
params: Promise<{
|
|
40
66
|
lang: string;
|
|
41
67
|
slug?: string[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../../src/routes/llms.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"llms.d.ts","sourceRoot":"","sources":["../../src/routes/llms.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,KAAK,eAAe,EAGrB,MAAM,cAAc,CAAC;AAQtB,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE1D,KAAK,YAAY,GAAG,qBAAqB,CAAC;AAC1C,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAYhF,UAAU,kBAAkB;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,UAAU,wBAAwB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,KAAK,iBAAiB,GAAG,CACvB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B,UAAU,sBAAsB;IAC9B,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC;IACzE,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AA+LD,eAAO,MAAM,eAAe,GAAI,6CAK7B,sBAAsB;gBAIf,WAAW,cACL;QAAE,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE;;CAgCpD,CAAC;AAEF,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE,IAAI,CACX,eAAe,EACf,UAAU,GAAG,iBAAiB,GAAG,cAAc,CAChD,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC;IAC7D,oEAAoE;IACpE,QAAQ,CAAC,EAAE,KAAK,GAAG,uBAAuB,CAAC;IAC3C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,iBAAiB,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB;IACtC,uDAAuD;IACvD,kBAAkB,CAAC,EAAE,CAAC,OAAO,EAAE;QAC7B,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,aAAa,CAAC;QACpB,MAAM,EAAE,YAAY,CAAC;KACtB,KAAK,MAAM,CAAC;IACb;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,KAAK,MAAM,CAAC;IACzE,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kEAAkE;IAClE,MAAM,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;CACpB;AAED,eAAO,MAAM,uBAAuB,GAAI,wFAOrC,8BAA8B;oBAwLnB,OAAO,cACL;QAAE,MAAM,EAAE,OAAO,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC,CAAA;KAAE;yCAsCjE;QACD,MAAM,CAAC,EAAE,OAAO,CAAC;YAAE,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACrC;;CAgBF,CAAC"}
|
package/dist/routes/llms.js
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
import { notFound } from "next/navigation";
|
|
2
|
-
import {
|
|
2
|
+
import { getPublicPath, normalizeBasePath, } from "../config.js";
|
|
3
|
+
import { resolvePageMarkdownUrl } from "../internal/markdown-url.js";
|
|
4
|
+
import { isPageVisibleForSurface } from "../internal/page-visibility.js";
|
|
5
|
+
import { findSmartNotFoundSuggestions, renderSmartNotFoundMarkdown, } from "../internal/smart-not-found.js";
|
|
6
|
+
const INDEX_MARKDOWN_PATTERN = /\/index\.md$/;
|
|
7
|
+
const MARKDOWN_PATTERN = /\.md$/;
|
|
3
8
|
const resolveSources = (source, sources, caller) => {
|
|
4
9
|
const resolvedSources = sources ?? (source ? [source] : []);
|
|
5
10
|
if (resolvedSources.length === 0) {
|
|
@@ -12,6 +17,55 @@ const getPathnameFromSlug = (slug) => {
|
|
|
12
17
|
const segments = slug ?? [];
|
|
13
18
|
return segments.length === 0 ? "/" : `/${segments.join("/")}`;
|
|
14
19
|
};
|
|
20
|
+
const joinPath = (...parts) => {
|
|
21
|
+
const segments = parts.flatMap((part) => part?.split("/").filter(Boolean) ?? []);
|
|
22
|
+
return segments.length === 0 ? "/" : `/${segments.join("/")}`;
|
|
23
|
+
};
|
|
24
|
+
const getLocalePrefix = ({ config, lang, sources, }) => {
|
|
25
|
+
const defaultLanguage = config?.defaultLanguage ?? "en";
|
|
26
|
+
if (lang !== defaultLanguage) {
|
|
27
|
+
return `/${lang}`;
|
|
28
|
+
}
|
|
29
|
+
const sampleUrl = sources
|
|
30
|
+
.flatMap((source) => source.source.getPages(lang))
|
|
31
|
+
.at(0)?.url;
|
|
32
|
+
return sampleUrl?.startsWith(`/${lang}/`) ? `/${lang}` : undefined;
|
|
33
|
+
};
|
|
34
|
+
const stripPathPrefix = (pathname, prefix) => {
|
|
35
|
+
if (!prefix || pathname === prefix) {
|
|
36
|
+
return pathname === prefix ? "/" : pathname;
|
|
37
|
+
}
|
|
38
|
+
return pathname.startsWith(`${prefix}/`)
|
|
39
|
+
? pathname.slice(prefix.length)
|
|
40
|
+
: pathname;
|
|
41
|
+
};
|
|
42
|
+
const selectSuggestionPages = (pathname, pages) => {
|
|
43
|
+
const matches = pages.filter((page) => page.scope === "/" ||
|
|
44
|
+
pathname === page.scope ||
|
|
45
|
+
pathname.startsWith(`${page.scope}/`));
|
|
46
|
+
const longestScope = Math.max(0, ...matches.map((page) => page.scope?.split("/").filter(Boolean).length ?? 0));
|
|
47
|
+
return matches.length === 0
|
|
48
|
+
? pages
|
|
49
|
+
: matches.filter((page) => (page.scope?.split("/").filter(Boolean).length ?? 0) === longestScope);
|
|
50
|
+
};
|
|
51
|
+
const selectRouteSources = (pathname, sources) => {
|
|
52
|
+
const sourceScopes = sources.map((source) => ({
|
|
53
|
+
scope: joinPath(source.baseUrl),
|
|
54
|
+
source,
|
|
55
|
+
}));
|
|
56
|
+
const matches = sourceScopes.filter(({ scope }) => scope === "/" || pathname === scope || pathname.startsWith(`${scope}/`));
|
|
57
|
+
const longestScope = Math.max(0, ...matches.map(({ scope }) => scope.split("/").filter(Boolean).length));
|
|
58
|
+
return matches.length === 0
|
|
59
|
+
? sources
|
|
60
|
+
: matches
|
|
61
|
+
.filter(({ scope }) => scope.split("/").filter(Boolean).length === longestScope)
|
|
62
|
+
.map(({ source }) => source);
|
|
63
|
+
};
|
|
64
|
+
const markdownUrlToPath = (url) => url.replace(INDEX_MARKDOWN_PATTERN, "/").replace(MARKDOWN_PATTERN, "");
|
|
65
|
+
const getPageScope = (path, slugCount) => {
|
|
66
|
+
const segments = path.split("/").filter(Boolean);
|
|
67
|
+
return joinPath(...segments.slice(0, Math.max(0, segments.length - slugCount)));
|
|
68
|
+
};
|
|
15
69
|
const findPageBySlug = ({ lang, slug, sources, }) => {
|
|
16
70
|
for (const source of sources) {
|
|
17
71
|
const page = source.source.getPage(slug, lang);
|
|
@@ -74,13 +128,140 @@ export const createLlmsRoute = ({ filterPage, source, sources, transform, }) =>
|
|
|
74
128
|
revalidate: false,
|
|
75
129
|
};
|
|
76
130
|
};
|
|
77
|
-
export const createDocsMarkdownRoute = ({ filterStaticParams, source, sources, transform, }) => {
|
|
131
|
+
export const createDocsMarkdownRoute = ({ config, filterStaticParams, notFound: notFoundOptions = false, source, sources, transform, }) => {
|
|
78
132
|
const routeSources = resolveSources(source, sources, "createDocsMarkdownRoute");
|
|
79
|
-
const
|
|
133
|
+
const routingConfig = config ?? routeSources[0].routingConfig ?? {};
|
|
134
|
+
const smartNotFoundOptions = notFoundOptions === false ? {} : notFoundOptions;
|
|
135
|
+
const supportedLanguages = new Set([
|
|
136
|
+
routingConfig.defaultLanguage ?? "en",
|
|
137
|
+
...Object.keys(routingConfig.translations ?? {}),
|
|
138
|
+
]);
|
|
139
|
+
const suggestionPageCache = new Map();
|
|
140
|
+
const localePrefixCache = new Map();
|
|
141
|
+
const getCachedLocalePrefix = (lang) => {
|
|
142
|
+
if (localePrefixCache.has(lang)) {
|
|
143
|
+
return localePrefixCache.get(lang);
|
|
144
|
+
}
|
|
145
|
+
const localePrefix = getLocalePrefix({
|
|
146
|
+
config: routingConfig,
|
|
147
|
+
lang,
|
|
148
|
+
sources: routeSources,
|
|
149
|
+
});
|
|
150
|
+
localePrefixCache.set(lang, localePrefix);
|
|
151
|
+
return localePrefix;
|
|
152
|
+
};
|
|
153
|
+
const getSuggestionPages = (lang) => {
|
|
154
|
+
if (!supportedLanguages.has(lang)) {
|
|
155
|
+
return [];
|
|
156
|
+
}
|
|
157
|
+
const cached = suggestionPageCache.get(lang);
|
|
158
|
+
if (cached) {
|
|
159
|
+
return cached;
|
|
160
|
+
}
|
|
161
|
+
const localePrefix = getCachedLocalePrefix(lang);
|
|
162
|
+
const pages = routeSources.flatMap((entry) => entry.source
|
|
163
|
+
.getPages(lang)
|
|
164
|
+
.filter((page) => isPageVisibleForSurface(page, "llms"))
|
|
165
|
+
.map((page) => {
|
|
166
|
+
const data = page.data;
|
|
167
|
+
const configuredUrl = smartNotFoundOptions.getPageMarkdownUrl?.({
|
|
168
|
+
lang,
|
|
169
|
+
page,
|
|
170
|
+
source: entry,
|
|
171
|
+
});
|
|
172
|
+
const url = configuredUrl?.startsWith("/") && !configuredUrl.startsWith("//")
|
|
173
|
+
? getPublicPath(configuredUrl, routingConfig.basePath)
|
|
174
|
+
: resolvePageMarkdownUrl({
|
|
175
|
+
basePath: routingConfig.basePath,
|
|
176
|
+
isRootMountedPage: entry.baseUrl === "/" && page.slugs.length === 0,
|
|
177
|
+
pageUrl: page.url,
|
|
178
|
+
});
|
|
179
|
+
const appUrl = stripPathPrefix(markdownUrlToPath(url), normalizeBasePath(routingConfig.basePath));
|
|
180
|
+
const path = localePrefix
|
|
181
|
+
? stripPathPrefix(appUrl, localePrefix)
|
|
182
|
+
: appUrl;
|
|
183
|
+
return {
|
|
184
|
+
title: data.title ?? page.url,
|
|
185
|
+
description: data.description ?? data.summary,
|
|
186
|
+
keywords: data.keywords,
|
|
187
|
+
path,
|
|
188
|
+
scope: getPageScope(path, page.slugs.length),
|
|
189
|
+
source: entry,
|
|
190
|
+
url,
|
|
191
|
+
};
|
|
192
|
+
}));
|
|
193
|
+
suggestionPageCache.set(lang, pages);
|
|
194
|
+
return pages;
|
|
195
|
+
};
|
|
196
|
+
const getRequestedPathContext = ({ lang, slug, }) => {
|
|
197
|
+
const localePrefix = getCachedLocalePrefix(lang);
|
|
198
|
+
const fallbackPath = getPublicPath(routeSources.length === 1
|
|
199
|
+
? joinPath(localePrefix, routeSources[0].baseUrl, ...(slug ?? []))
|
|
200
|
+
: joinPath(localePrefix, ...(slug ?? [])), routingConfig.basePath);
|
|
201
|
+
const configuredPath = smartNotFoundOptions.getRequestedPath?.({
|
|
202
|
+
lang,
|
|
203
|
+
slug: slug ?? [],
|
|
204
|
+
});
|
|
205
|
+
const requestedPath = configuredPath?.startsWith("/") && !configuredPath.startsWith("//")
|
|
206
|
+
? getPublicPath(configuredPath, routingConfig.basePath)
|
|
207
|
+
: fallbackPath;
|
|
208
|
+
const appPath = stripPathPrefix(requestedPath, normalizeBasePath(routingConfig.basePath));
|
|
209
|
+
const localizedPath = localePrefix
|
|
210
|
+
? stripPathPrefix(appPath, localePrefix)
|
|
211
|
+
: appPath;
|
|
212
|
+
return { lang, localePrefix, localizedPath, requestedPath };
|
|
213
|
+
};
|
|
214
|
+
const getLookupSources = (pathContext) => {
|
|
215
|
+
const baseUrlMatches = selectRouteSources(pathContext.localizedPath, routeSources);
|
|
216
|
+
if (!smartNotFoundOptions.getPageMarkdownUrl) {
|
|
217
|
+
return baseUrlMatches;
|
|
218
|
+
}
|
|
219
|
+
const mappedPages = selectSuggestionPages(pathContext.localizedPath, getSuggestionPages(pathContext.lang));
|
|
220
|
+
const mappedSources = new Set(mappedPages.map((page) => page.source));
|
|
221
|
+
return mappedSources.size > 0
|
|
222
|
+
? routeSources.filter((source) => mappedSources.has(source))
|
|
223
|
+
: baseUrlMatches;
|
|
224
|
+
};
|
|
225
|
+
const createSmartNotFoundResponse = ({ pathContext, }) => {
|
|
226
|
+
const { localePrefix, localizedPath, requestedPath } = pathContext;
|
|
227
|
+
const suggestionPages = selectSuggestionPages(localizedPath, getSuggestionPages(pathContext.lang));
|
|
228
|
+
const suggestions = findSmartNotFoundSuggestions(localizedPath, suggestionPages, {
|
|
229
|
+
limit: smartNotFoundOptions.maxSuggestions,
|
|
230
|
+
minScore: smartNotFoundOptions.minScore,
|
|
231
|
+
});
|
|
232
|
+
const allPagesUrl = getPublicPath(joinPath(localePrefix, "/llms.txt"), routingConfig.basePath);
|
|
233
|
+
return new Response(renderSmartNotFoundMarkdown({
|
|
234
|
+
allPagesUrl,
|
|
235
|
+
requestedPath,
|
|
236
|
+
suggestions,
|
|
237
|
+
}), {
|
|
238
|
+
status: smartNotFoundOptions.status ?? 200,
|
|
239
|
+
headers: {
|
|
240
|
+
"Cache-Control": "public, max-age=0, s-maxage=300",
|
|
241
|
+
"Content-Type": "text/markdown; charset=utf-8",
|
|
242
|
+
Link: `<${requestedPath}>; rel="canonical"`,
|
|
243
|
+
Vary: "Accept",
|
|
244
|
+
"X-Geistdocs-Not-Found": "1",
|
|
245
|
+
"X-Robots-Tag": "noindex",
|
|
246
|
+
},
|
|
247
|
+
});
|
|
248
|
+
};
|
|
249
|
+
const GET = async (_request, { params }) => {
|
|
80
250
|
const { slug, lang } = await params;
|
|
81
|
-
const
|
|
251
|
+
const pathContext = notFoundOptions
|
|
252
|
+
? getRequestedPathContext({ lang, slug })
|
|
253
|
+
: undefined;
|
|
254
|
+
const lookupSources = pathContext
|
|
255
|
+
? getLookupSources(pathContext)
|
|
256
|
+
: routeSources;
|
|
257
|
+
const result = findPageBySlug({ lang, slug, sources: lookupSources });
|
|
82
258
|
if (!result) {
|
|
83
|
-
|
|
259
|
+
if (!pathContext) {
|
|
260
|
+
notFound();
|
|
261
|
+
}
|
|
262
|
+
return createSmartNotFoundResponse({
|
|
263
|
+
pathContext,
|
|
264
|
+
});
|
|
84
265
|
}
|
|
85
266
|
const { page, source: pageSource } = result;
|
|
86
267
|
const rendered = await pageSource.getPageMarkdown(page);
|
package/dist/source.d.ts
CHANGED
|
@@ -63,6 +63,11 @@ export interface CreateVersionedSourcesOptions {
|
|
|
63
63
|
}
|
|
64
64
|
export declare const createSource: ({ docs, config, baseUrl, id, label, markdown, }: CreateSourceOptions) => {
|
|
65
65
|
baseUrl: string;
|
|
66
|
+
routingConfig: {
|
|
67
|
+
basePath: string | undefined;
|
|
68
|
+
defaultLanguage: string | undefined;
|
|
69
|
+
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
70
|
+
};
|
|
66
71
|
source: import("fumadocs-core/source").LoaderOutput<{
|
|
67
72
|
source: import("fumadocs-core/source").SourceConfig;
|
|
68
73
|
i18n: import("fumadocs-core/i18n").I18nConfig<string>;
|
|
@@ -89,6 +94,11 @@ export declare const createSources: ({ config, sources }: CreateSourcesOptions)
|
|
|
89
94
|
label: string | undefined;
|
|
90
95
|
source: {
|
|
91
96
|
baseUrl: string;
|
|
97
|
+
routingConfig: {
|
|
98
|
+
basePath: string | undefined;
|
|
99
|
+
defaultLanguage: string | undefined;
|
|
100
|
+
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
101
|
+
};
|
|
92
102
|
source: import("fumadocs-core/source").LoaderOutput<{
|
|
93
103
|
source: import("fumadocs-core/source").SourceConfig;
|
|
94
104
|
i18n: import("fumadocs-core/i18n").I18nConfig<string>;
|
|
@@ -119,6 +129,11 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
119
129
|
routePrefix: string | undefined;
|
|
120
130
|
source: {
|
|
121
131
|
baseUrl: string;
|
|
132
|
+
routingConfig: {
|
|
133
|
+
basePath: string | undefined;
|
|
134
|
+
defaultLanguage: string | undefined;
|
|
135
|
+
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
136
|
+
};
|
|
122
137
|
source: import("fumadocs-core/source").LoaderOutput<{
|
|
123
138
|
source: import("fumadocs-core/source").SourceConfig;
|
|
124
139
|
i18n: import("fumadocs-core/i18n").I18nConfig<string>;
|
|
@@ -140,6 +155,11 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
140
155
|
}[];
|
|
141
156
|
byId: Record<string, {
|
|
142
157
|
baseUrl: string;
|
|
158
|
+
routingConfig: {
|
|
159
|
+
basePath: string | undefined;
|
|
160
|
+
defaultLanguage: string | undefined;
|
|
161
|
+
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
162
|
+
};
|
|
143
163
|
source: import("fumadocs-core/source").LoaderOutput<{
|
|
144
164
|
source: import("fumadocs-core/source").SourceConfig;
|
|
145
165
|
i18n: import("fumadocs-core/i18n").I18nConfig<string>;
|
|
@@ -160,6 +180,11 @@ export declare const createVersionedSources: ({ config, current, versions, }: Cr
|
|
|
160
180
|
}>;
|
|
161
181
|
current: {
|
|
162
182
|
baseUrl: string;
|
|
183
|
+
routingConfig: {
|
|
184
|
+
basePath: string | undefined;
|
|
185
|
+
defaultLanguage: string | undefined;
|
|
186
|
+
translations: import("./config.js").GeistdocsTranslations | undefined;
|
|
187
|
+
};
|
|
163
188
|
source: import("fumadocs-core/source").LoaderOutput<{
|
|
164
189
|
source: import("fumadocs-core/source").SourceConfig;
|
|
165
190
|
i18n: import("fumadocs-core/i18n").I18nConfig<string>;
|
package/dist/source.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,MAAM,EAEP,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAG1B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,6BAA6B,CAAC;AAErC,YAAY,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEzE,KAAK,aAAa,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AA0FlD,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,IAAI,CACV,eAAe,EACf,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,cAAc,CAC1D,CAAC;IACF,IAAI,EAAE,kBAAkB,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,wBAAwB,CAAC;CACrC;AAED,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kCACf,SAAQ,yBAAyB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,yBAAyB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kCAAkC,EAAE,CAAC;CAChD;AAgCD,eAAO,MAAM,YAAY,GAAI,iDAO1B,mBAAmB
|
|
1
|
+
{"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../src/source.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,aAAa,EAClB,MAAM,EAEP,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EAG1B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,qBAAqB,EAE3B,MAAM,6BAA6B,CAAC;AAErC,YAAY,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEzE,KAAK,aAAa,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;AA0FlD,MAAM,WAAW,kBAAkB;IACjC,gBAAgB,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE;QACJ,IAAI,EAAE,uBAAuB,CAAC;QAC9B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;CACH;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,CAAC,EAAE,CACV,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,IAAI,CACV,eAAe,EACf,OAAO,GAAG,UAAU,GAAG,iBAAiB,GAAG,cAAc,CAC1D,CAAC;IACF,IAAI,EAAE,kBAAkB,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,wBAAwB,CAAC;CACrC;AAED,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kCACf,SAAQ,yBAAyB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,yBAAyB,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kCAAkC,EAAE,CAAC;CAChD;AAgCD,eAAO,MAAM,YAAY,GAAI,iDAO1B,mBAAmB;;;;;;;;;;;;;yBAkBQ,aAAa;;;OAAe;;;;4BASnB,aAAa;;;OAAe;CA8FlE,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAEpE,eAAO,MAAM,uBAAuB,GAClC,QAAQ,OAAO,KACd,MAAM,IAAI,qBAKC,CAAC;AAEf,eAAO,MAAM,aAAa,GAAI,qBAAqB,oBAAoB;;;;;;;;;;;;;;;;;iCApHzC,aAAa;;;eAAe;;;;oCASnB,aAAa;;;eAAe;;;UA+H1D,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC;CAE7C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,gCAIpC,6BAA6B;;;;;;;;;;;;;;;;;;;;iCAhJF,aAAa;;;eAAe;;;;oCASnB,aAAa;;;eAAe;;;;;;;;;;;;;;;;6BATrC,aAAa;;;WAAe;;;;gCASnB,aAAa;;;WAAe;;;;;;;;;;;;;;;6BATrC,aAAa;;;WAAe;;;;gCASnB,aAAa;;;WAAe;;;CA0KlE,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE;YAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,KAAK,MAAM,CAAC;IAC7E,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,qBAAqB,GAAG,qBAAqB,EAAE,CAAC;CAC1D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAAI,6CAKjC,0BAA0B,KAAG,MAAM,EAYrC,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,UAAU,CAAC,EAAE,0BAA0B,CAAC,YAAY,CAAC,CAAC;IACtD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,EAAE,KAAK,CAAC,CAAC;CAClE;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,iCAIvC,gCAAgC,KAAG,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAiBvE,CAAC"}
|
package/dist/source.js
CHANGED
|
@@ -164,6 +164,11 @@ For an index of all available documentation, see [${llmsLabel}](${llmsPath})${ag
|
|
|
164
164
|
};
|
|
165
165
|
return {
|
|
166
166
|
baseUrl,
|
|
167
|
+
routingConfig: {
|
|
168
|
+
basePath: config.basePath,
|
|
169
|
+
defaultLanguage: config.defaultLanguage,
|
|
170
|
+
translations: config.translations,
|
|
171
|
+
},
|
|
167
172
|
source,
|
|
168
173
|
id,
|
|
169
174
|
label,
|
package/docs/agents.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Docs
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 1.19.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.19.4 so agents can understand the installed package without web access.
|
|
4
4
|
They are generated from `apps/template/content/docs` during the package build.
|
|
5
5
|
|
|
6
6
|
## How to use these files
|
package/docs/llms.txt
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Documentation
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 1.19.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 1.19.4.
|
|
4
4
|
They describe how to build package-backed Geistdocs sites and how to use the package APIs from generated project adapters.
|
|
5
5
|
|
|
6
6
|
## Documentation Index
|
|
@@ -572,6 +572,7 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
|
572
572
|
|
|
573
573
|
export const { GET, generateStaticParams, revalidate } =
|
|
574
574
|
createDocsMarkdownRoute({
|
|
575
|
+
notFound: {},
|
|
575
576
|
source: geistdocsSource,
|
|
576
577
|
});
|
|
577
578
|
```
|
|
@@ -2203,6 +2204,7 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
|
2203
2204
|
|
|
2204
2205
|
export const { GET, generateStaticParams, revalidate } =
|
|
2205
2206
|
createDocsMarkdownRoute({
|
|
2207
|
+
notFound: {},
|
|
2206
2208
|
sources: [geistdocsSource],
|
|
2207
2209
|
});
|
|
2208
2210
|
```
|
|
@@ -2219,6 +2221,27 @@ The response includes:
|
|
|
2219
2221
|
|
|
2220
2222
|
All MDX components are processed and converted to plain Markdown equivalents.
|
|
2221
2223
|
|
|
2224
|
+
## Missing pages
|
|
2225
|
+
|
|
2226
|
+
When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
|
|
2227
|
+
|
|
2228
|
+
For example, a request for `/docs/env-vars` can suggest `/docs/environment-variables.md`. The response uses a short cache lifetime and a `200` status because many agents discard useful bodies on `404` responses. Regular HTML requests keep the app's standard not-found behavior.
|
|
2229
|
+
|
|
2230
|
+
Enable this behavior with `notFound: {}`. Pass `notFound: { status: 404 }` to use a semantic HTTP status. Without `notFound`, Markdown requests use the standard Next.js not-found response.
|
|
2231
|
+
|
|
2232
|
+
If a custom `markdownRoutes` mapping changes the public path shape, set `notFound.getRequestedPath` to reconstruct the app-local public pathname. This also keeps page lookup and suggestions within the right source when a flattened route serves multiple sources:
|
|
2233
|
+
|
|
2234
|
+
```ts
|
|
2235
|
+
notFound: {
|
|
2236
|
+
getRequestedPath: ({ slug }) =>
|
|
2237
|
+
slug[0] === "integrations"
|
|
2238
|
+
? `/${slug.join("/")}`
|
|
2239
|
+
: ["/docs", ...slug].join("/"),
|
|
2240
|
+
},
|
|
2241
|
+
```
|
|
2242
|
+
|
|
2243
|
+
Set `notFound.getPageMarkdownUrl` as well when suggested pages use a custom app-local Markdown URL.
|
|
2244
|
+
|
|
2222
2245
|
|
|
2223
2246
|
---
|
|
2224
2247
|
|
package/docs/manifest.json
CHANGED
package/docs/pages/md.md
CHANGED
|
@@ -71,6 +71,7 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
|
71
71
|
|
|
72
72
|
export const { GET, generateStaticParams, revalidate } =
|
|
73
73
|
createDocsMarkdownRoute({
|
|
74
|
+
notFound: {},
|
|
74
75
|
sources: [geistdocsSource],
|
|
75
76
|
});
|
|
76
77
|
```
|
|
@@ -86,3 +87,24 @@ The response includes:
|
|
|
86
87
|
- Processed Markdown content from Fumadocs
|
|
87
88
|
|
|
88
89
|
All MDX components are processed and converted to plain Markdown equivalents.
|
|
90
|
+
|
|
91
|
+
## Missing pages
|
|
92
|
+
|
|
93
|
+
When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
|
|
94
|
+
|
|
95
|
+
For example, a request for `/docs/env-vars` can suggest `/docs/environment-variables.md`. The response uses a short cache lifetime and a `200` status because many agents discard useful bodies on `404` responses. Regular HTML requests keep the app's standard not-found behavior.
|
|
96
|
+
|
|
97
|
+
Enable this behavior with `notFound: {}`. Pass `notFound: { status: 404 }` to use a semantic HTTP status. Without `notFound`, Markdown requests use the standard Next.js not-found response.
|
|
98
|
+
|
|
99
|
+
If a custom `markdownRoutes` mapping changes the public path shape, set `notFound.getRequestedPath` to reconstruct the app-local public pathname. This also keeps page lookup and suggestions within the right source when a flattened route serves multiple sources:
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
notFound: {
|
|
103
|
+
getRequestedPath: ({ slug }) =>
|
|
104
|
+
slug[0] === "integrations"
|
|
105
|
+
? `/${slug.join("/")}`
|
|
106
|
+
: ["/docs", ...slug].join("/"),
|
|
107
|
+
},
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Set `notFound.getPageMarkdownUrl` as well when suggested pages use a custom app-local Markdown URL.
|
package/docs/pages/migration.md
CHANGED
package/package.json
CHANGED
|
@@ -69,6 +69,7 @@ import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
|
69
69
|
|
|
70
70
|
export const { GET, generateStaticParams, revalidate } =
|
|
71
71
|
createDocsMarkdownRoute({
|
|
72
|
+
notFound: {},
|
|
72
73
|
sources: [geistdocsSource],
|
|
73
74
|
});
|
|
74
75
|
```
|
|
@@ -84,3 +85,24 @@ The response includes:
|
|
|
84
85
|
- Processed Markdown content from Fumadocs
|
|
85
86
|
|
|
86
87
|
All MDX components are processed and converted to plain Markdown equivalents.
|
|
88
|
+
|
|
89
|
+
## Missing pages
|
|
90
|
+
|
|
91
|
+
When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
|
|
92
|
+
|
|
93
|
+
For example, a request for `/docs/env-vars` can suggest `/docs/environment-variables.md`. The response uses a short cache lifetime and a `200` status because many agents discard useful bodies on `404` responses. Regular HTML requests keep the app's standard not-found behavior.
|
|
94
|
+
|
|
95
|
+
Enable this behavior with `notFound: {}`. Pass `notFound: { status: 404 }` to use a semantic HTTP status. Without `notFound`, Markdown requests use the standard Next.js not-found response.
|
|
96
|
+
|
|
97
|
+
If a custom `markdownRoutes` mapping changes the public path shape, set `notFound.getRequestedPath` to reconstruct the app-local public pathname. This also keeps page lookup and suggestions within the right source when a flattened route serves multiple sources:
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
notFound: {
|
|
101
|
+
getRequestedPath: ({ slug }) =>
|
|
102
|
+
slug[0] === "integrations"
|
|
103
|
+
? `/${slug.join("/")}`
|
|
104
|
+
: ["/docs", ...slug].join("/"),
|
|
105
|
+
},
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Set `notFound.getPageMarkdownUrl` as well when suggested pages use a custom app-local Markdown URL.
|
package/template/package.json
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"@streamdown/code": "^1.0.1",
|
|
19
19
|
"@vercel/agent-readability": "^0.2.1",
|
|
20
20
|
"@vercel/analytics": "^1.6.1",
|
|
21
|
-
"@vercel/geistdocs": "1.19.
|
|
21
|
+
"@vercel/geistdocs": "1.19.4",
|
|
22
22
|
"@vercel/speed-insights": "^1.3.1",
|
|
23
23
|
"ai": "^6.0.132",
|
|
24
24
|
"class-variance-authority": "^0.7.1",
|