@vercel/geistdocs 2.15.3 → 2.15.4-canary.0faac50
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/page-actions-client.js +1 -1
- package/dist/mobile-docs-bar.js +1 -1
- package/docs/agents.md +1 -1
- package/docs/llms.txt +13 -1
- package/docs/manifest.json +1 -1
- package/docs/pages/configuration.md +12 -0
- package/package.json +15 -8
- package/rehype-code-highlights.d.ts +13 -0
- package/rehype-code-highlights.js +278 -0
- package/shared-theme.css +7 -1
- package/source-config-public.d.ts +15 -0
- package/source-config-public.js +44 -0
- package/template/content/docs/configuration.mdx +12 -0
- package/template/package.json +1 -1
package/dist/cli/index.js
CHANGED
|
@@ -4,4 +4,4 @@ import{Option as Rn,program as A}from"commander";import{access as Ke,copyFile as
|
|
|
4
4
|
`);throw new AggregateError(i,`Mixedbread search sync did not complete:
|
|
5
5
|
${a}`)}return r},Ft=async({client:e,file:t,pollIntervalMs:n,pollTimeoutMs:r,sleep:i})=>{let s=t,o=Date.now()+r;for(;s.status==="pending"||s.status==="in_progress";){if(Date.now()>=o)throw new Error(`Mixedbread timed out while indexing file ${t.id}.`);await i(n),s=await e.retrieveStoreFile(t.id)}if(s.status!=="completed")throw new Error(`Mixedbread failed to index file ${t.id} (${s.status}).`);return s},Dt=async({client:e,desired:t,pollIntervalMs:n,pollTimeoutMs:r,sleep:i})=>{let s=await e.uploadFile({content:t.document.content,filename:`${U(t.document.id).slice(0,32)}.md`}),o;try{o=await e.createStoreFile({externalId:t.externalId,fileId:s,metadata:{...t.metadata,[g.rawFileId]:s}})}catch(a){try{await e.deleteFile(s)}catch(d){throw new AggregateError([a,d],`Mixedbread failed to attach and clean up raw file ${s}.`)}throw a}return Ft({client:e,file:o,pollIntervalMs:n,pollTimeoutMs:r,sleep:i})},Ie=async({client:e,concurrency:t=St,manifest:n,pollIntervalMs:r=_t,pollTimeoutMs:i=Tt,revision:s,revisionAncestors:o=[],revisionTimestamp:a,sleep:d=Rt})=>{let c=_e(n);if(c.provider!=="mixedbread")return{deleted:0,skipped:c.documents.length,uploaded:0};let u=c.siteId?.trim();if(!u)throw new Error("Mixedbread retrieval requires a non-empty siteId in geistdocs.tsx.");if(c.documents.length===0)throw new Error("The Geistdocs search export is empty. Refusing to remove indexed documents.");let l=c.documents.map(p=>At(p,u,s,o,a)),m=new Map(l.map(p=>[p.document.id,p])),h=(await be(e)).flatMap(p=>{let y=q(p.metadata);return y?.siteId===u?[{file:p,metadata:y}]:[]}),x=new Map,P=new Set;for(let p of h){W(p.metadata,s,a)&&P.add(p.metadata.documentId);let y=m.get(p.metadata.documentId);y&&p.metadata.contentHash===y.hash&&p.file.status==="completed"&&!x.has(p.metadata.documentId)&&x.set(p.metadata.documentId,p)}let _=l.filter(p=>!(x.has(p.document.id)||P.has(p.document.id)));await Ee(_,t,p=>Dt({client:e,desired:p,pollIntervalMs:r,pollTimeoutMs:i,sleep:d}));let b=(await be(e)).flatMap(p=>{let y=q(p.metadata);return y?.siteId===u?[{file:p,metadata:y}]:[]}),D=new Set(b.filter(({metadata:p})=>W(p,s,a)).map(({metadata:p})=>p.documentId)),ie=new Set;for(let p of l){if(D.has(p.document.id))continue;let ae=b.filter(({file:V,metadata:k})=>V.status==="completed"&&k.documentId===p.document.id&&k.contentHash===p.hash).sort((V,k)=>V.file.id.localeCompare(k.file.id))[0];ae&&ie.add(ae.file.id)}let oe=b.filter(({file:p,metadata:y})=>p.status!=="pending"&&p.status!=="in_progress"&&!W(y,s,a)&&Mt({currentRevision:s,currentRevisionAncestors:o,currentRevisionTimestamp:a,desired:m.get(y.documentId),metadata:y})&&!ie.has(p.id));return await Ee(oe,t,async({file:p,metadata:y})=>{await e.deleteFile(y.rawFileId??p.id),await e.deleteStoreFile(p.id)}),{deleted:oe.length,skipped:l.length-_.length,uploaded:_.length}};var Ot=50,$t=e=>`vercel integration add mixedbread --name docs-${e||"your-site-id"} --environment production`,ve=(e,t)=>kt("git",t,{cwd:e,encoding:"utf8",stdio:["ignore","pipe","ignore"]}).trim(),Nt=e=>{let t=process.env.VERCEL_GIT_COMMIT_SHA?.trim(),n=[];try{n=ve(e,["rev-list",`--max-count=${Ot+1}`,t||"HEAD"]).split(`
|
|
6
6
|
`).filter(Boolean)}catch{n=[]}let r=t||n[0],i;for(let s of Array.from(new Set([r,"HEAD"].filter(Boolean))))try{let o=Number(ve(e,["show","-s","--format=%ct",s]));if(Number.isFinite(o)){i=o;break}}catch{}return{revision:r,revisionAncestors:n.filter(s=>s!==r),revisionTimestamp:i}},Pe=async({allowNonProduction:e=!1,dir:t=".next"}={})=>{let n=process.cwd();Ct.loadEnvConfig(n,!1);let r=process.env.MXBAI_API_KEY?.trim(),i=process.env.MXBAI_STORE_ID?.trim();if(process.env.VERCEL_ENV!=="production"&&!e){console.log("Geistdocs search sync skipped: this is not a production Vercel build.");return}if(!!r!=!!i)throw new Error("Mixedbread is partially configured. Set both MXBAI_API_KEY and MXBAI_STORE_ID.");let s;try{s=await Te({cwd:n,outputDirectory:t})}catch(a){if(!(r||i)){console.log("Geistdocs search sync skipped: no Mixedbread credentials or static search export were found.");return}throw a}if(s.provider!=="mixedbread"){console.log("Geistdocs search sync skipped: Ask AI uses local retrieval.");return}if(!(r&&i))throw new Error(["Mixedbread retrieval is enabled, but MXBAI_API_KEY or MXBAI_STORE_ID is missing.","From the root of this site's repository, linked to the correct Vercel project, run:",$t(s.siteId)].join(`
|
|
7
|
-
`));let o=await Ie({client:we({apiBaseUrl:process.env.MXBAI_BASE_URL,apiKey:r,storeId:i}),manifest:s,...Nt(n)});console.log(`Geistdocs search sync complete: ${o.uploaded} uploaded, ${o.deleted} deleted, ${o.skipped} unchanged.`)};import{readFileSync as Gt,writeFileSync as Ut}from"fs";import{mkdir as Lt,readFile as Z,writeFile as jt}from"fs/promises";import{dirname as Bt,extname as Vt,relative as Fe,resolve as j}from"path";import{intro as Jt,isCancel as Ht,log as I,multiselect as Xt,outro as L,spinner as Kt}from"@clack/prompts";import{glob as Yt}from"glob";import{Node as F,Project as qt,SyntaxKind as zt}from"ts-morph";var Wt="geistdocs.tsx",Qt="content/docs/**/*.mdx",ee=".translation-cache.json",Q=8,Ae=()=>({version:1,entries:{}}),Zt=async e=>{let t=await Z(e),{createHash:n}=await import("crypto");return n("sha256").update(t).digest("hex")},en=e=>{let t=j(process.cwd(),e);return Gt(t,"utf8")},Me=e=>F.isObjectLiteralExpression(e)?e.getProperties().flatMap(t=>{if(F.isPropertyAssignment(t)){let n=t.getNameNode();if(F.isIdentifier(n)||F.isStringLiteral(n))return[n.getText().replaceAll(/['"]/g,"")]}return[]}).filter(Boolean):[],tn=e=>{try{let t=new qt({compilerOptions:{allowJs:!0,jsx:4,module:99,target:10},skipAddingFilesFromTsConfig:!0,useInMemoryFileSystem:!0}),n=en(e),s=t.createSourceFile(e,n,{overwrite:!0}).getVariableDeclarations().find(a=>a.getName()==="translations")?.getInitializer();if(!s)return[];if(F.isObjectLiteralExpression(s))return Me(s);let o=s.getFirstDescendantByKind(zt.ObjectLiteralExpression);return o?Me(o):[]}catch(t){let n=t instanceof Error?t.message:`${t}`;return I.warn(`Failed to read locales from ${e}: ${n}`),[]}},nn=async()=>{let e=await Xt({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 Ht(e)&&(L("Translation cancelled"),process.exit(0)),e},rn=async e=>(await Yt(e,{cwd:process.cwd(),absolute:!0,nodir:!0})).sort(),sn=async()=>{let e=j(process.cwd(),ee);try{let t=await Z(e,"utf8"),n=JSON.parse(t);return n.version!==1||!n.entries?Ae():{version:1,entries:n.entries}}catch{return Ae()}},Re=e=>{let t=j(process.cwd(),ee),n=JSON.stringify(e,null,2);Ut(t,n,"utf8")},on=async e=>{let t=await Promise.all(e.map(async n=>[n,await Zt(n)]));return Object.fromEntries(t)},an=(e,t)=>{let n=Vt(e);return`${e.slice(0,-n.length)}.${t}${n}`},De=(e,t)=>`${Fe(process.cwd(),e)}::${t}`,cn=(e,t,n,r,i=!1)=>{let s=[],o=0;for(let a of t){let d=n[a];for(let c of e){let u=an(a,c),l=De(a,c),m=r.entries[l];if(!i&&m?.hash===d){o+=1;continue}s.push({locale:c,sourceFile:a,sourceHash:d,targetFile:u})}}return{tasks:s,skippedCount:o}},dn=async e=>{await Lt(Bt(e),{recursive:!0})},ln=async(e,t,n)=>{let r=await fetch(e,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({content:t,locale:n})});if(!r.ok){let s=await r.text();throw new Error(`API request failed (${r.status}): ${s}`)}let i=await r.json();if(!i.translation)throw new Error("API response did not include a translation");return i.translation},pn=async(e,t,n)=>{let r=await Z(e.sourceFile,"utf8"),i=await ln(t,r,e.locale);await dn(e.targetFile),await jt(e.targetFile,i,"utf8"),n.entries[De(e.sourceFile,e.locale)]={hash:e.sourceHash,updatedAt:new Date().toISOString()}},ke=async(e,t)=>{Jt("Translate MDX content");let n=e??Qt,r=t.url||process.env.GEISTDOCS_TRANSLATE_URL||"https://geistdocs.com/translate",i=tn(t.config??Wt),s=await rn(n);s.length===0&&(I.error(`No MDX files found matching pattern: ${n}`),L("Translation cancelled"),process.exit(1)),I.info(`Found ${s.length} MDX file(s) matching pattern`),i.length===0&&(i=await nn());let o=j(process.cwd(),ee),a=await sn();await Re(a),I.info(`Using cache: ${o}`);let d=await on(s),{tasks:c,skippedCount:u}=cn(i,s,d,a,t.force);if(c.length===0){I.success("All translations are up to date!"),L(`Skipped ${u} file(s) (unchanged)`);return}let l=[];for(let h=0;h<c.length;h+=Q)l.push(c.slice(h,h+Q));I.info(`Processing ${c.length} translation(s) in ${l.length} batch(es) of up to ${Q}`),u>0&&I.info(`Skipped ${u} translation(s) (unchanged)`);let m=Kt();m.start("Translating content...");let f=0;for(let h of l)await Promise.all(h.map(async x=>{await pn(x,r,a),f+=1,m.message(`Translated ${f}/${c.length}: ${Fe(process.cwd(),x.targetFile)}`)})),await Re(a);m.stop("Translation complete!"),L(`Created/updated ${c.length} file(s)`)};import{access as un,copyFile as gn,mkdir as Ne,rm as re}from"fs/promises";import{dirname as mn,join as v}from"path";import{intro as fn,log as w,outro as B,spinner as Ge}from"@clack/prompts";import{glob as hn}from"glob";var wn=["**/*"],yn=["content/docs/**"],te=".geistdocs-tmp",xn=async(e,t)=>{let n=v(e,t);await re(n,{recursive:!0,force:!0}),await Ne(n,{recursive:!0})},ne=async e=>await re(e,{recursive:!0,force:!0}),Ce=async(e,t,n)=>(await hn(e,{cwd:n,nodir:!0,dot:!0,ignore:[".git/**",...t]})).sort(),bn=async e=>{try{return await un(e),!0}catch{return!1}},En=async(e,t,n)=>{let r=v(t,e),i=v(n,e);return await bn(r)?(await gn(r,i),{success:!0}):{success:!1,error:`Source file not found: ${r}`}},Sn=async(e,t)=>{let n=v(t,e);return await re(n,{force:!0}),{success:!0}},Oe=20,$e=async(e,t,n)=>{let r=[];for(let i=0;i<e.length;i+=n){let s=e.slice(i,i+n),o=await Promise.all(s.map(t));r.push(...o)}return r},_n=async(e,t,n,r,i)=>{let s={success:[],deleted:[],failed:[]},o=[...new Set(e.map(d=>mn(v(r,d))))];i.message(`Creating ${o.length} directories...`),await Promise.all(o.map(d=>Ne(d,{recursive:!0}))),i.message(`Updating ${e.length} files...`);let a=await $e(e,async d=>{let c=await En(d,n,r);return{file:d,...c}},Oe);for(let{file:d,success:c,error:u}of a)c?s.success.push(d):s.failed.push({file:d,error:u??"Unknown error"});if(t.length>0){i.message(`Deleting ${t.length} files...`);let d=await $e(t,async c=>{try{return await Sn(c,r),{file:c,success:!0}}catch(u){let l=u instanceof Error?u.message:`${u}`;return{file:c,success:!1,error:l}}},Oe);for(let c of d)c.success?s.deleted.push(c.file):s.failed.push({file:c.file,error:c.error})}return s},Tn=e=>{if(e.success.length>0){w.success(`Successfully updated ${e.success.length} files:`);for(let t of e.success)w.info(` \u2713 ${t}`)}if(e.deleted.length>0){w.success(`Deleted ${e.deleted.length} files:`);for(let t of e.deleted)w.info(` \u{1F5D1} ${t}`)}if(e.failed.length>0){w.warn(`Failed to update ${e.failed.length} files:`);for(let{file:t,error:n}of e.failed)w.error(` \u2717 ${t}: ${n}`)}},In=e=>e.includes("canary")?"canary":"latest",vn=async e=>{let t=await fetch(`https://registry.npmjs.org/${encodeURIComponent(S)}`);if(!t.ok)throw new Error(`Failed to resolve ${S}@${e}`);let r=(await t.json())["dist-tags"]?.[e];if(!r)throw new Error(`Could not find dist-tag ${e} for ${S}`);return r},Pn=async e=>{let t=await M(e),n=J(t,S);if(!n)return{currentVersion:n,nextVersion:void 0,updated:!1};let r=In(n),i=await vn(r);return n===i?{currentVersion:n,nextVersion:i,updateTag:r,updated:!1}:($(t,S,i),await O(e,t),{currentVersion:n,nextVersion:i,updateTag:r,updated:!0})},An=async(e,t,n)=>{let r=await M(e);if(!le(r,S))return!1;t&&t.length>0&&w.warn("Ignoring file patterns for a package-based site. This update will bump the package version instead."),n?.sync&&w.warn("Ignoring --sync for a package-based site. Runtime updates now come from the package version.");let{currentVersion:i,nextVersion:s,updateTag:o,updated:a}=await Pn(e);if(!a)return w.success(i?`@vercel/geistdocs is already at ${s} (${o}).`:"No package version update was needed."),B("Package-based site is already up to date."),!0;w.info(`Bumping ${S} from ${i} to ${s} (${o})`);let d=Ge();return d.start("Installing updated package version..."),await T("pnpm",["install"],{cwd:e}),d.stop("Package update complete!"),B("Please review and test the upgraded package version."),!0},Mn=async(e,t,n,r,i)=>{let s=v(e,te),o=Ge(),a=i?.sync?s:t;o.start("Preparing template snapshot..."),i?.sync&&(await xn(e,te),await N(s)),o.message("Scanning for files...");let d=await Ce(n,r,a),c=[];if(i?.sync){o.message("Comparing with local files...");let l=await Ce(n,r,e),m=new Set(d);c=l.filter(f=>!m.has(f))}if(o.stop(`Found ${d.length} files to update`),d.length===0&&c.length===0){w.warn("No files matched the patterns. Nothing to update."),i?.sync&&await ne(s),B("Update cancelled.");return}w.info(`Patterns: ${n.length}`),w.info(`Files to update: ${d.length}`),i?.sync&&w.info(`Files to delete: ${c.length}`),o.start("Updating files...");let u=await _n(d,c,a,e,o);i?.sync&&(o.message("Cleaning up..."),await ne(s)),o.stop("Update complete!"),Tn(u),B("Please review and test the changes carefully.")},Ue=async(e,t)=>{let n=process.cwd(),r=H(),i=e&&e.length>0?e:wn,s=e&&e.length>0?[]:yn;try{if(fn("Let's update your Geistdocs project!"),await An(n,e,t))return;w.info("Template source: bundled package snapshot"),e&&e.length>0&&w.info(`Updating specific files: ${e.join(", ")}`),t?.sync&&w.info("Sync mode enabled: will delete files removed from template"),await Mn(n,r,i,s,t)}catch(o){let a=o instanceof Error?o.message:`${o}`;try{await ne(v(n,te))}catch{}w.error(`Failed to update project: ${a}`),process.exit(1)}};A.name("geistdocs").description("CLI for Geistdocs projects").version("2.15.3","-v, --version","Output the current version");A.command("init").description("Initialize a new Geistdocs project").option("--name <name>","Name of the project").addOption(new Rn("--brand <brand>","Navbar brand").choices(["vercel","labs"]).default("vercel")).option("--disable-git","Disable git initialization").action(he);A.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(Ue);A.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(ke);var Fn=A.command("search").description("Manage the external search index used by Ask AI");Fn.command("sync").description("Sync the latest static docs export to Mixedbread").option("--dir <path>","Next.js output directory",".next").option("--allow-non-production","Run outside a production Vercel build").action(Pe);await A.parseAsync(process.argv).catch(e=>{console.error(e instanceof Error?e.message:e),process.exitCode=1});
|
|
7
|
+
`));let o=await Ie({client:we({apiBaseUrl:process.env.MXBAI_BASE_URL,apiKey:r,storeId:i}),manifest:s,...Nt(n)});console.log(`Geistdocs search sync complete: ${o.uploaded} uploaded, ${o.deleted} deleted, ${o.skipped} unchanged.`)};import{readFileSync as Gt,writeFileSync as Ut}from"fs";import{mkdir as Lt,readFile as Z,writeFile as jt}from"fs/promises";import{dirname as Bt,extname as Vt,relative as Fe,resolve as j}from"path";import{intro as Jt,isCancel as Ht,log as I,multiselect as Xt,outro as L,spinner as Kt}from"@clack/prompts";import{glob as Yt}from"glob";import{Node as F,Project as qt,SyntaxKind as zt}from"ts-morph";var Wt="geistdocs.tsx",Qt="content/docs/**/*.mdx",ee=".translation-cache.json",Q=8,Ae=()=>({version:1,entries:{}}),Zt=async e=>{let t=await Z(e),{createHash:n}=await import("crypto");return n("sha256").update(t).digest("hex")},en=e=>{let t=j(process.cwd(),e);return Gt(t,"utf8")},Me=e=>F.isObjectLiteralExpression(e)?e.getProperties().flatMap(t=>{if(F.isPropertyAssignment(t)){let n=t.getNameNode();if(F.isIdentifier(n)||F.isStringLiteral(n))return[n.getText().replaceAll(/['"]/g,"")]}return[]}).filter(Boolean):[],tn=e=>{try{let t=new qt({compilerOptions:{allowJs:!0,jsx:4,module:99,target:10},skipAddingFilesFromTsConfig:!0,useInMemoryFileSystem:!0}),n=en(e),s=t.createSourceFile(e,n,{overwrite:!0}).getVariableDeclarations().find(a=>a.getName()==="translations")?.getInitializer();if(!s)return[];if(F.isObjectLiteralExpression(s))return Me(s);let o=s.getFirstDescendantByKind(zt.ObjectLiteralExpression);return o?Me(o):[]}catch(t){let n=t instanceof Error?t.message:`${t}`;return I.warn(`Failed to read locales from ${e}: ${n}`),[]}},nn=async()=>{let e=await Xt({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 Ht(e)&&(L("Translation cancelled"),process.exit(0)),e},rn=async e=>(await Yt(e,{cwd:process.cwd(),absolute:!0,nodir:!0})).sort(),sn=async()=>{let e=j(process.cwd(),ee);try{let t=await Z(e,"utf8"),n=JSON.parse(t);return n.version!==1||!n.entries?Ae():{version:1,entries:n.entries}}catch{return Ae()}},Re=e=>{let t=j(process.cwd(),ee),n=JSON.stringify(e,null,2);Ut(t,n,"utf8")},on=async e=>{let t=await Promise.all(e.map(async n=>[n,await Zt(n)]));return Object.fromEntries(t)},an=(e,t)=>{let n=Vt(e);return`${e.slice(0,-n.length)}.${t}${n}`},De=(e,t)=>`${Fe(process.cwd(),e)}::${t}`,cn=(e,t,n,r,i=!1)=>{let s=[],o=0;for(let a of t){let d=n[a];for(let c of e){let u=an(a,c),l=De(a,c),m=r.entries[l];if(!i&&m?.hash===d){o+=1;continue}s.push({locale:c,sourceFile:a,sourceHash:d,targetFile:u})}}return{tasks:s,skippedCount:o}},dn=async e=>{await Lt(Bt(e),{recursive:!0})},ln=async(e,t,n)=>{let r=await fetch(e,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify({content:t,locale:n})});if(!r.ok){let s=await r.text();throw new Error(`API request failed (${r.status}): ${s}`)}let i=await r.json();if(!i.translation)throw new Error("API response did not include a translation");return i.translation},pn=async(e,t,n)=>{let r=await Z(e.sourceFile,"utf8"),i=await ln(t,r,e.locale);await dn(e.targetFile),await jt(e.targetFile,i,"utf8"),n.entries[De(e.sourceFile,e.locale)]={hash:e.sourceHash,updatedAt:new Date().toISOString()}},ke=async(e,t)=>{Jt("Translate MDX content");let n=e??Qt,r=t.url||process.env.GEISTDOCS_TRANSLATE_URL||"https://geistdocs.com/translate",i=tn(t.config??Wt),s=await rn(n);s.length===0&&(I.error(`No MDX files found matching pattern: ${n}`),L("Translation cancelled"),process.exit(1)),I.info(`Found ${s.length} MDX file(s) matching pattern`),i.length===0&&(i=await nn());let o=j(process.cwd(),ee),a=await sn();await Re(a),I.info(`Using cache: ${o}`);let d=await on(s),{tasks:c,skippedCount:u}=cn(i,s,d,a,t.force);if(c.length===0){I.success("All translations are up to date!"),L(`Skipped ${u} file(s) (unchanged)`);return}let l=[];for(let h=0;h<c.length;h+=Q)l.push(c.slice(h,h+Q));I.info(`Processing ${c.length} translation(s) in ${l.length} batch(es) of up to ${Q}`),u>0&&I.info(`Skipped ${u} translation(s) (unchanged)`);let m=Kt();m.start("Translating content...");let f=0;for(let h of l)await Promise.all(h.map(async x=>{await pn(x,r,a),f+=1,m.message(`Translated ${f}/${c.length}: ${Fe(process.cwd(),x.targetFile)}`)})),await Re(a);m.stop("Translation complete!"),L(`Created/updated ${c.length} file(s)`)};import{access as un,copyFile as gn,mkdir as Ne,rm as re}from"fs/promises";import{dirname as mn,join as v}from"path";import{intro as fn,log as w,outro as B,spinner as Ge}from"@clack/prompts";import{glob as hn}from"glob";var wn=["**/*"],yn=["content/docs/**"],te=".geistdocs-tmp",xn=async(e,t)=>{let n=v(e,t);await re(n,{recursive:!0,force:!0}),await Ne(n,{recursive:!0})},ne=async e=>await re(e,{recursive:!0,force:!0}),Ce=async(e,t,n)=>(await hn(e,{cwd:n,nodir:!0,dot:!0,ignore:[".git/**",...t]})).sort(),bn=async e=>{try{return await un(e),!0}catch{return!1}},En=async(e,t,n)=>{let r=v(t,e),i=v(n,e);return await bn(r)?(await gn(r,i),{success:!0}):{success:!1,error:`Source file not found: ${r}`}},Sn=async(e,t)=>{let n=v(t,e);return await re(n,{force:!0}),{success:!0}},Oe=20,$e=async(e,t,n)=>{let r=[];for(let i=0;i<e.length;i+=n){let s=e.slice(i,i+n),o=await Promise.all(s.map(t));r.push(...o)}return r},_n=async(e,t,n,r,i)=>{let s={success:[],deleted:[],failed:[]},o=[...new Set(e.map(d=>mn(v(r,d))))];i.message(`Creating ${o.length} directories...`),await Promise.all(o.map(d=>Ne(d,{recursive:!0}))),i.message(`Updating ${e.length} files...`);let a=await $e(e,async d=>{let c=await En(d,n,r);return{file:d,...c}},Oe);for(let{file:d,success:c,error:u}of a)c?s.success.push(d):s.failed.push({file:d,error:u??"Unknown error"});if(t.length>0){i.message(`Deleting ${t.length} files...`);let d=await $e(t,async c=>{try{return await Sn(c,r),{file:c,success:!0}}catch(u){let l=u instanceof Error?u.message:`${u}`;return{file:c,success:!1,error:l}}},Oe);for(let c of d)c.success?s.deleted.push(c.file):s.failed.push({file:c.file,error:c.error})}return s},Tn=e=>{if(e.success.length>0){w.success(`Successfully updated ${e.success.length} files:`);for(let t of e.success)w.info(` \u2713 ${t}`)}if(e.deleted.length>0){w.success(`Deleted ${e.deleted.length} files:`);for(let t of e.deleted)w.info(` \u{1F5D1} ${t}`)}if(e.failed.length>0){w.warn(`Failed to update ${e.failed.length} files:`);for(let{file:t,error:n}of e.failed)w.error(` \u2717 ${t}: ${n}`)}},In=e=>e.includes("canary")?"canary":"latest",vn=async e=>{let t=await fetch(`https://registry.npmjs.org/${encodeURIComponent(S)}`);if(!t.ok)throw new Error(`Failed to resolve ${S}@${e}`);let r=(await t.json())["dist-tags"]?.[e];if(!r)throw new Error(`Could not find dist-tag ${e} for ${S}`);return r},Pn=async e=>{let t=await M(e),n=J(t,S);if(!n)return{currentVersion:n,nextVersion:void 0,updated:!1};let r=In(n),i=await vn(r);return n===i?{currentVersion:n,nextVersion:i,updateTag:r,updated:!1}:($(t,S,i),await O(e,t),{currentVersion:n,nextVersion:i,updateTag:r,updated:!0})},An=async(e,t,n)=>{let r=await M(e);if(!le(r,S))return!1;t&&t.length>0&&w.warn("Ignoring file patterns for a package-based site. This update will bump the package version instead."),n?.sync&&w.warn("Ignoring --sync for a package-based site. Runtime updates now come from the package version.");let{currentVersion:i,nextVersion:s,updateTag:o,updated:a}=await Pn(e);if(!a)return w.success(i?`@vercel/geistdocs is already at ${s} (${o}).`:"No package version update was needed."),B("Package-based site is already up to date."),!0;w.info(`Bumping ${S} from ${i} to ${s} (${o})`);let d=Ge();return d.start("Installing updated package version..."),await T("pnpm",["install"],{cwd:e}),d.stop("Package update complete!"),B("Please review and test the upgraded package version."),!0},Mn=async(e,t,n,r,i)=>{let s=v(e,te),o=Ge(),a=i?.sync?s:t;o.start("Preparing template snapshot..."),i?.sync&&(await xn(e,te),await N(s)),o.message("Scanning for files...");let d=await Ce(n,r,a),c=[];if(i?.sync){o.message("Comparing with local files...");let l=await Ce(n,r,e),m=new Set(d);c=l.filter(f=>!m.has(f))}if(o.stop(`Found ${d.length} files to update`),d.length===0&&c.length===0){w.warn("No files matched the patterns. Nothing to update."),i?.sync&&await ne(s),B("Update cancelled.");return}w.info(`Patterns: ${n.length}`),w.info(`Files to update: ${d.length}`),i?.sync&&w.info(`Files to delete: ${c.length}`),o.start("Updating files...");let u=await _n(d,c,a,e,o);i?.sync&&(o.message("Cleaning up..."),await ne(s)),o.stop("Update complete!"),Tn(u),B("Please review and test the changes carefully.")},Ue=async(e,t)=>{let n=process.cwd(),r=H(),i=e&&e.length>0?e:wn,s=e&&e.length>0?[]:yn;try{if(fn("Let's update your Geistdocs project!"),await An(n,e,t))return;w.info("Template source: bundled package snapshot"),e&&e.length>0&&w.info(`Updating specific files: ${e.join(", ")}`),t?.sync&&w.info("Sync mode enabled: will delete files removed from template"),await Mn(n,r,i,s,t)}catch(o){let a=o instanceof Error?o.message:`${o}`;try{await ne(v(n,te))}catch{}w.error(`Failed to update project: ${a}`),process.exit(1)}};A.name("geistdocs").description("CLI for Geistdocs projects").version("2.15.4-canary.0faac50","-v, --version","Output the current version");A.command("init").description("Initialize a new Geistdocs project").option("--name <name>","Name of the project").addOption(new Rn("--brand <brand>","Navbar brand").choices(["vercel","labs"]).default("vercel")).option("--disable-git","Disable git initialization").action(he);A.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(Ue);A.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(ke);var Fn=A.command("search").description("Manage the external search index used by Ask AI");Fn.command("sync").description("Sync the latest static docs export to Mixedbread").option("--dir <path>","Next.js output directory",".next").option("--allow-non-production","Run outside a production Vercel build").action(Pe);await A.parseAsync(process.argv).catch(e=>{console.error(e instanceof Error?e.message:e),process.exitCode=1});
|
|
@@ -156,6 +156,6 @@ export const GeistdocsPageActions = ({ config, page, only, }) => {
|
|
|
156
156
|
// rendered below the title and left-aligned.
|
|
157
157
|
const rootClassName = only === "mobile"
|
|
158
158
|
? "@min-[961px]:hidden"
|
|
159
|
-
: "mb-2 self-end @max-[
|
|
159
|
+
: "mb-2 self-end @max-[961px]:hidden";
|
|
160
160
|
return (_jsxs("div", { className: rootClassName, onFocusCapture: preloadChat, onPointerEnter: preloadChat, children: [showDesktop ? (_jsx(DesktopPageActions, { askAIEnabled: askAIEnabled, checked: checked, copyEnabled: copyEnabled, editSourceEnabled: editSourceEnabled, editSourceUrl: editSourceUrl, isMobile: isMobile, menuView: menuView, onAskAI: onAskAI, onCopy: handleCopy, onPrefetchMarkdown: prefetchMarkdown, onViewMarkdown: handleViewMarkdown, openInChatEnabled: openInChatEnabled, openInChatRef: openInChatRef, otherProviders: otherProviders, providersBackRef: providersBackRef, query: query, setMenuView: setMenuView, v0Provider: v0Provider })) : null, showMobile && (copyEnabled || askAIEnabled) ? (_jsx(InlinePageActions, { askAIEnabled: askAIEnabled, checked: checked, copyEnabled: copyEnabled, onAskAI: onAskAI, onCopy: handleCopy, onPrefetchMarkdown: prefetchMarkdown, onViewMarkdown: handleViewMarkdown })) : null, _jsx("span", { "aria-live": "polite", className: "sr-only", children: checked ? "Page copied" : "" })] }));
|
|
161
161
|
};
|
package/dist/mobile-docs-bar.js
CHANGED
|
@@ -22,7 +22,7 @@ export const MobileDocsBar = ({ toc }) => {
|
|
|
22
22
|
const [tocOpen, setTocOpen] = useState(false);
|
|
23
23
|
const activeAnchors = useActiveAnchors();
|
|
24
24
|
const hasToc = Boolean(toc && toc.length > 0);
|
|
25
|
-
return (_jsxs(_Fragment, { children: [_jsx("div", { className: "sticky top-16 z-30 -mx-6 -mt-6 mb-6 flex @min-[961px]:hidden h-[54px] items-center border-b bg-background-200 px-6", "data-mobile-docs-bar": true, children: _jsxs("button", { "aria-expanded": sidebarOpen, "aria-haspopup": "dialog", className: "-ml-2 flex min-h-8 touch-manipulation items-center gap-3 rounded-md px-2 text-gray-1000 text-label-16 transition-colors hover:bg-gray-alpha-100 focus-visible:shadow-[var(--ds-focus-ring)] focus-visible:outline-none active:bg-gray-alpha-300 motion-reduce:transition-none", onClick: () => setSidebarOpen(true), type: "button", children: [_jsx(IconMenuAlt, { size: 16 }), "Menu"] }) }), hasToc ? (_jsx("div", { className: "pointer-events-none sticky top-[calc(4rem+70px)] z-30 -mb-12 flex @min-[961px]:hidden justify-end", children: _jsxs(Popover, { onOpenChange: setTocOpen, open: tocOpen, children: [_jsx(PopoverTrigger, { asChild: true, children: _jsx("button", { "aria-label": "Table of contents", className: "pointer-events-auto flex size-8 touch-manipulation items-center justify-center rounded-md bg-background-100 text-gray-900 shadow-[var(--ds-shadow-border)] transition-colors hover:border-gray-alpha-500 hover:text-gray-1000 focus-visible:shadow-[var(--ds-focus-ring)] focus-visible:outline-none active:border-gray-alpha-600 data-[state=open]:border-gray-alpha-600 data-[state=open]:text-gray-1000 motion-reduce:transition-none", "data-mobile-toc-trigger": true, type: "button", children: _jsx(IconFileText, { size: 16 }) }) }), _jsx(PopoverContent, { align: "end", className: "w-64 overflow-hidden p-0", "data-geistdocs-mobile-toc": true, sideOffset: 8, children: _jsxs("div", { className: "max-h-[min(50vh,20rem)] overflow-y-auto overscroll-contain p-4", children: [_jsx("p", { className: "mb-2 font-medium text-gray-1000 text-xs uppercase tracking-wider", children: "On this page" }), _jsx("nav", { className: "flex flex-col", children: toc?.map((item) => {
|
|
25
|
+
return (_jsxs(_Fragment, { children: [_jsx("div", { className: "sticky top-16 z-30 -mx-6 -mt-6 mb-6 flex @min-[961px]:hidden h-[54px] items-center border-b bg-background-200 px-6 md:-mt-8 xl:-mt-14", "data-mobile-docs-bar": true, children: _jsxs("button", { "aria-expanded": sidebarOpen, "aria-haspopup": "dialog", className: "-ml-2 flex min-h-8 touch-manipulation items-center gap-3 rounded-md px-2 text-gray-1000 text-label-16 transition-colors hover:bg-gray-alpha-100 focus-visible:shadow-[var(--ds-focus-ring)] focus-visible:outline-none active:bg-gray-alpha-300 motion-reduce:transition-none", onClick: () => setSidebarOpen(true), type: "button", children: [_jsx(IconMenuAlt, { size: 16 }), "Menu"] }) }), hasToc ? (_jsx("div", { className: "pointer-events-none sticky top-[calc(4rem+70px)] z-30 -mb-12 flex @min-[961px]:hidden justify-end", children: _jsxs(Popover, { onOpenChange: setTocOpen, open: tocOpen, children: [_jsx(PopoverTrigger, { asChild: true, children: _jsx("button", { "aria-label": "Table of contents", className: "pointer-events-auto flex size-8 touch-manipulation items-center justify-center rounded-md bg-background-100 text-gray-900 shadow-[var(--ds-shadow-border)] transition-colors hover:border-gray-alpha-500 hover:text-gray-1000 focus-visible:shadow-[var(--ds-focus-ring)] focus-visible:outline-none active:border-gray-alpha-600 data-[state=open]:border-gray-alpha-600 data-[state=open]:text-gray-1000 motion-reduce:transition-none", "data-mobile-toc-trigger": true, type: "button", children: _jsx(IconFileText, { size: 16 }) }) }), _jsx(PopoverContent, { align: "end", className: "w-64 overflow-hidden p-0", "data-geistdocs-mobile-toc": true, sideOffset: 8, children: _jsxs("div", { className: "max-h-[min(50vh,20rem)] overflow-y-auto overscroll-contain p-4", children: [_jsx("p", { className: "mb-2 font-medium text-gray-1000 text-xs uppercase tracking-wider", children: "On this page" }), _jsx("nav", { className: "flex flex-col", children: toc?.map((item) => {
|
|
26
26
|
const id = item.url.slice(1);
|
|
27
27
|
const active = activeAnchors.includes(id);
|
|
28
28
|
return (_jsx(Link, { className: "wrap-anywhere block py-1.5 text-gray-900 text-sm transition-colors first:pt-0 last:pb-0 hover:text-fd-accent-foreground focus-visible:shadow-[var(--ds-focus-ring)] focus-visible:outline-none data-[active=true]:text-fd-primary motion-reduce:transition-none", "data-active": active ? "true" : undefined, href: item.url, onClick: () => setTocOpen(false), prefetch: false, style: {
|
package/docs/agents.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Geistdocs Package Docs
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 2.15.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 2.15.4-canary.0faac50 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` 2.15.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 2.15.4-canary.0faac50.
|
|
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
|
|
@@ -1424,6 +1424,18 @@ export const docs = defineDocs({
|
|
|
1424
1424
|
export default defineGeistdocsSourceConfig();
|
|
1425
1425
|
```
|
|
1426
1426
|
|
|
1427
|
+
### Code highlighter (public package)
|
|
1428
|
+
|
|
1429
|
+
The public package uses [Highlights](https://diffs.com/highlights), which tokenizes code with WebAssembly lexers while keeping the JavaScript MDX compiler. Geist colors, titles, icons, tabs and `[!code ...]` annotations are preserved. Some token colors differ from Shiki, and unsupported languages render as plain text. To use Shiki's TextMate grammars instead, pass `highlighter: "shiki"`:
|
|
1430
|
+
|
|
1431
|
+
```ts title="source.config.ts"
|
|
1432
|
+
export default defineGeistdocsSourceConfig({ highlighter: "shiki" });
|
|
1433
|
+
```
|
|
1434
|
+
|
|
1435
|
+
Set `highlighter: false` or `mdxOptions.rehypeCodeOptions: false` to disable built-in highlighting when providing your own plugin. A `rehypePlugins` callback can also remove or replace Fumadocs' default highlighter without Highlights being added back.
|
|
1436
|
+
|
|
1437
|
+
The private package retains its existing Shiki pipeline. The `highlighter` option above is available only in the public package.
|
|
1438
|
+
|
|
1427
1439
|
To serve docs from the site root, use `route: "/"` in `content` and `baseUrl: "/"` in `createSource`. Root-mounted docs need explicit `markdownRoutes`; Geistdocs does not infer a broad `/*path` mapping because it can capture homepages and non-docs app routes.
|
|
1428
1440
|
|
|
1429
1441
|
## Page URLs
|
package/docs/manifest.json
CHANGED
|
@@ -285,6 +285,18 @@ export const docs = defineDocs({
|
|
|
285
285
|
export default defineGeistdocsSourceConfig();
|
|
286
286
|
```
|
|
287
287
|
|
|
288
|
+
### Code highlighter (public package)
|
|
289
|
+
|
|
290
|
+
The public package uses [Highlights](https://diffs.com/highlights), which tokenizes code with WebAssembly lexers while keeping the JavaScript MDX compiler. Geist colors, titles, icons, tabs and `[!code ...]` annotations are preserved. Some token colors differ from Shiki, and unsupported languages render as plain text. To use Shiki's TextMate grammars instead, pass `highlighter: "shiki"`:
|
|
291
|
+
|
|
292
|
+
```ts title="source.config.ts"
|
|
293
|
+
export default defineGeistdocsSourceConfig({ highlighter: "shiki" });
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
Set `highlighter: false` or `mdxOptions.rehypeCodeOptions: false` to disable built-in highlighting when providing your own plugin. A `rehypePlugins` callback can also remove or replace Fumadocs' default highlighter without Highlights being added back.
|
|
297
|
+
|
|
298
|
+
The private package retains its existing Shiki pipeline. The `highlighter` option above is available only in the public package.
|
|
299
|
+
|
|
288
300
|
To serve docs from the site root, use `route: "/"` in `content` and `baseUrl: "/"` in `createSource`. Root-mounted docs need explicit `markdownRoutes`; Geistdocs does not infer a broad `/*path` mapping because it can capture homepages and non-docs app routes.
|
|
289
301
|
|
|
290
302
|
## Page URLs
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vercel/geistdocs",
|
|
3
3
|
"description": "Runtime and CLI for Geistdocs projects.",
|
|
4
|
-
"version": "2.15.
|
|
4
|
+
"version": "2.15.4-canary.0faac50",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -27,11 +27,15 @@
|
|
|
27
27
|
"cli.js",
|
|
28
28
|
"dist",
|
|
29
29
|
"docs",
|
|
30
|
+
"rehype-code-highlights.d.ts",
|
|
31
|
+
"rehype-code-highlights.js",
|
|
30
32
|
"rehype-task-list-labels.d.ts",
|
|
31
33
|
"rehype-task-list-labels.js",
|
|
32
34
|
"remark-details.d.ts",
|
|
33
35
|
"remark-details.js",
|
|
34
36
|
"source-config.js",
|
|
37
|
+
"source-config-public.js",
|
|
38
|
+
"source-config-public.d.ts",
|
|
35
39
|
"template",
|
|
36
40
|
"public-foundation.css",
|
|
37
41
|
"shared-theme.css",
|
|
@@ -161,8 +165,8 @@
|
|
|
161
165
|
"default": "./dist/providers/public/utils.js"
|
|
162
166
|
},
|
|
163
167
|
"./source-config": {
|
|
164
|
-
"types": "./
|
|
165
|
-
"default": "./source-config.js"
|
|
168
|
+
"types": "./source-config-public.d.ts",
|
|
169
|
+
"default": "./source-config-public.js"
|
|
166
170
|
},
|
|
167
171
|
"./docs/agents.md": "./docs/agents.md",
|
|
168
172
|
"./docs/llms.txt": "./docs/llms.txt",
|
|
@@ -301,12 +305,18 @@
|
|
|
301
305
|
"./theme.css": "./theme.css",
|
|
302
306
|
"./package.json": "./package.json"
|
|
303
307
|
},
|
|
308
|
+
"scripts": {
|
|
309
|
+
"build": "rm -rf dist docs template && node ./scripts/bundle-template.mjs && node ./scripts/bundle-docs.mjs && tsc -p tsconfig.runtime.json && tsup --config tsup.config.cli.ts",
|
|
310
|
+
"dev": "tsc -p tsconfig.runtime.json --watch --preserveWatchOutput"
|
|
311
|
+
},
|
|
304
312
|
"dependencies": {
|
|
305
313
|
"@ai-sdk/react": "^3.0.134",
|
|
306
314
|
"@clack/prompts": "^0.11.0",
|
|
307
315
|
"@modelcontextprotocol/server": "^2.0.0",
|
|
308
316
|
"@next/env": "16.3.3",
|
|
309
317
|
"@orama/tokenizers": "^3.1.16",
|
|
318
|
+
"@pierre/highlights": "0.5.1",
|
|
319
|
+
"@shikijs/rehype": "3.19.0",
|
|
310
320
|
"@streamdown/cjk": "^1.0.1",
|
|
311
321
|
"@types/mdx": "^2.0.13",
|
|
312
322
|
"@types/react": "^19.2.7",
|
|
@@ -335,6 +345,7 @@
|
|
|
335
345
|
"remark-mdx": "^3.1.1",
|
|
336
346
|
"remark-parse": "^11.0.0",
|
|
337
347
|
"remark-stringify": "^11.0.0",
|
|
348
|
+
"shiki": "3.19.0",
|
|
338
349
|
"sonner": "^2.0.8",
|
|
339
350
|
"streamdown": "^2.1.0",
|
|
340
351
|
"tailwind-merge": "^3.4.0",
|
|
@@ -364,9 +375,5 @@
|
|
|
364
375
|
"react-dom": "^19.2.3",
|
|
365
376
|
"tsup": "^8.5.1",
|
|
366
377
|
"typescript": "^5.9.3"
|
|
367
|
-
},
|
|
368
|
-
"scripts": {
|
|
369
|
-
"build": "rm -rf dist docs template && node ./scripts/bundle-template.mjs && node ./scripts/bundle-docs.mjs && tsc -p tsconfig.runtime.json && tsup --config tsup.config.cli.ts",
|
|
370
|
-
"dev": "tsc -p tsconfig.runtime.json --watch --preserveWatchOutput"
|
|
371
378
|
}
|
|
372
|
-
}
|
|
379
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { RehypeCodeOptions } from "fumadocs-core/mdx-plugins";
|
|
2
|
+
import type { Root } from "hast";
|
|
3
|
+
|
|
4
|
+
/** Zed-format Geist theme for @pierre/highlights, using Geist's Shiki CSS variables. */
|
|
5
|
+
export declare const geistHighlightsTheme: Record<string, unknown>;
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Drop-in for Fumadocs' `rehypeCode` that tokenizes with
|
|
9
|
+
* @pierre/highlights while keeping Shiki's HAST output and transformers.
|
|
10
|
+
*/
|
|
11
|
+
export declare const rehypeCodeHighlights: (
|
|
12
|
+
options?: Partial<RehypeCodeOptions>
|
|
13
|
+
) => (tree: Root, file: unknown) => Promise<void>;
|
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
import { codeToTokens, isSupportedLanguage } from "@pierre/highlights";
|
|
2
|
+
import rehypeShikiFromHighlighter from "@shikijs/rehype/core";
|
|
3
|
+
import {
|
|
4
|
+
rehypeCodeDefaultOptions,
|
|
5
|
+
transformerIcon,
|
|
6
|
+
transformerTab,
|
|
7
|
+
} from "fumadocs-core/mdx-plugins";
|
|
8
|
+
import { tokensToHast, transformerDecorations } from "shiki/core";
|
|
9
|
+
|
|
10
|
+
// Highlights code blocks with @pierre/highlights (hand-written
|
|
11
|
+
// Wasm lexers) instead of Shiki's TextMate grammars, while keeping Shiki's
|
|
12
|
+
// HAST output and transformer pipeline so Fumadocs' code block features
|
|
13
|
+
// (titles, icons, tabs, line notation, diffs, focus) keep working.
|
|
14
|
+
|
|
15
|
+
const v = (name) => `token-${name}`;
|
|
16
|
+
|
|
17
|
+
// Maps Highlights' Zed token names onto the same CSS variables the Geist
|
|
18
|
+
// Shiki theme uses (see `geistShikiTheme`), so the existing palette applies.
|
|
19
|
+
// With a `cssVariables` palette, colors are variable suffixes: `token-keyword`
|
|
20
|
+
// renders as `var(--shiki-token-keyword)`.
|
|
21
|
+
export const geistHighlightsTheme = {
|
|
22
|
+
name: "geist",
|
|
23
|
+
appearance: "light",
|
|
24
|
+
cssVariables: {
|
|
25
|
+
prefix: "--shiki-",
|
|
26
|
+
defaults: { "color-text": "inherit", "color-background": "transparent" },
|
|
27
|
+
},
|
|
28
|
+
style: {
|
|
29
|
+
"editor.foreground": "color-text",
|
|
30
|
+
"editor.background": "color-background",
|
|
31
|
+
syntax: {
|
|
32
|
+
comment: v("comment"),
|
|
33
|
+
"comment.doc": v("comment"),
|
|
34
|
+
"keyword.jsdoc": v("comment"),
|
|
35
|
+
"type.jsdoc": v("comment"),
|
|
36
|
+
"variable.jsdoc": v("comment"),
|
|
37
|
+
constant: v("constant"),
|
|
38
|
+
"constant.builtin": v("constant"),
|
|
39
|
+
boolean: v("constant"),
|
|
40
|
+
number: v("constant"),
|
|
41
|
+
enum: v("constant"),
|
|
42
|
+
"variable.special": v("constant"),
|
|
43
|
+
function: v("function"),
|
|
44
|
+
"function.definition": v("function"),
|
|
45
|
+
"function.method": v("function"),
|
|
46
|
+
constructor: v("function"),
|
|
47
|
+
type: v("function"),
|
|
48
|
+
"type.class": v("function"),
|
|
49
|
+
tag: v("function"),
|
|
50
|
+
"tag.jsx": v("function"),
|
|
51
|
+
"tag.component.jsx": v("function"),
|
|
52
|
+
"tag.doctype": v("function"),
|
|
53
|
+
title: v("function"),
|
|
54
|
+
namespace: v("function"),
|
|
55
|
+
selector: v("function"),
|
|
56
|
+
"selector.class": v("function"),
|
|
57
|
+
"selector.id": v("function"),
|
|
58
|
+
"selector.pseudo": v("function"),
|
|
59
|
+
attribute: v("constant"),
|
|
60
|
+
"attribute.jsx": v("constant"),
|
|
61
|
+
"variable.parameter": v("parameter"),
|
|
62
|
+
property: v("parameter"),
|
|
63
|
+
"property.json_key": v("parameter"),
|
|
64
|
+
label: v("parameter"),
|
|
65
|
+
"text.jsx": v("parameter"),
|
|
66
|
+
"punctuation.list_marker": v("parameter"),
|
|
67
|
+
keyword: v("keyword"),
|
|
68
|
+
"keyword.control": v("keyword"),
|
|
69
|
+
"keyword.declaration": v("keyword"),
|
|
70
|
+
"keyword.import": v("keyword"),
|
|
71
|
+
"keyword.operator": v("keyword"),
|
|
72
|
+
operator: v("keyword"),
|
|
73
|
+
preproc: v("keyword"),
|
|
74
|
+
string: v("string"),
|
|
75
|
+
"string.escape": v("string"),
|
|
76
|
+
"string.special": v("string"),
|
|
77
|
+
"string.special.symbol": v("string"),
|
|
78
|
+
"text.literal": v("string"),
|
|
79
|
+
"string.regex": v("string-expression"),
|
|
80
|
+
punctuation: v("punctuation"),
|
|
81
|
+
"punctuation.bracket": v("punctuation"),
|
|
82
|
+
"punctuation.delimiter": v("punctuation"),
|
|
83
|
+
"punctuation.special": v("keyword"),
|
|
84
|
+
"punctuation.markup": v("punctuation"),
|
|
85
|
+
"punctuation.bracket.html": v("parameter"),
|
|
86
|
+
"punctuation.bracket.jsx": v("parameter"),
|
|
87
|
+
"punctuation.delimiter.html": v("parameter"),
|
|
88
|
+
"punctuation.delimiter.jsx": v("parameter"),
|
|
89
|
+
link_uri: v("link"),
|
|
90
|
+
link_text: v("parameter"),
|
|
91
|
+
},
|
|
92
|
+
},
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
// Fenced-code names that Highlights doesn't know but Shiki users write.
|
|
96
|
+
const LANG_ALIASES = {
|
|
97
|
+
plaintext: "plain",
|
|
98
|
+
txt: "plain",
|
|
99
|
+
"": "plain",
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
const resolveLang = (lang) => {
|
|
103
|
+
const name = LANG_ALIASES[lang] ?? lang ?? "plain";
|
|
104
|
+
return isSupportedLanguage(name) ? name : "plain";
|
|
105
|
+
};
|
|
106
|
+
|
|
107
|
+
const TRAILING_NEWLINE = /\n$/;
|
|
108
|
+
|
|
109
|
+
const ENFORCE_ORDER = { pre: 0, undefined: 1, post: 2 };
|
|
110
|
+
|
|
111
|
+
const getTransformers = (options) => [
|
|
112
|
+
...[...(options.transformers ?? [])].sort(
|
|
113
|
+
(a, b) => ENFORCE_ORDER[a.enforce] - ENFORCE_ORDER[b.enforce]
|
|
114
|
+
),
|
|
115
|
+
transformerDecorations(),
|
|
116
|
+
];
|
|
117
|
+
|
|
118
|
+
const UNSTYLED = "var(--shiki-foreground)";
|
|
119
|
+
const COMMENT = "var(--shiki-token-comment)";
|
|
120
|
+
const TRAILING_SPACE = /[\t ]+$/;
|
|
121
|
+
|
|
122
|
+
const joinCommentWhitespace = (line) => {
|
|
123
|
+
for (let index = 1; index < line.length; index++) {
|
|
124
|
+
const token = line[index];
|
|
125
|
+
if (token.htmlStyle?.color !== COMMENT) {
|
|
126
|
+
continue;
|
|
127
|
+
}
|
|
128
|
+
// Shiki groups JSX indentation with the opening brace. Its annotation
|
|
129
|
+
// transformer recognizes a standalone JSX comment by those three tokens.
|
|
130
|
+
const opening = index - 1;
|
|
131
|
+
if (
|
|
132
|
+
token.content.trimStart().startsWith("/*") &&
|
|
133
|
+
line[opening].content.trim() === "{" &&
|
|
134
|
+
line[index + 1]?.content.trim() === "}" &&
|
|
135
|
+
line.slice(0, opening).every((part) => part.content.trim() === "")
|
|
136
|
+
) {
|
|
137
|
+
const indentation = line
|
|
138
|
+
.slice(0, opening)
|
|
139
|
+
.map((part) => part.content)
|
|
140
|
+
.join("");
|
|
141
|
+
line[opening].content = indentation + line[opening].content;
|
|
142
|
+
line[opening].offset -= indentation.length;
|
|
143
|
+
line.splice(0, opening);
|
|
144
|
+
index -= opening;
|
|
145
|
+
}
|
|
146
|
+
// Shiki includes the separator before a comment in its comment token.
|
|
147
|
+
// Match that boundary so notation removal also removes the separator,
|
|
148
|
+
// without trimming authored whitespace from unrelated code lines.
|
|
149
|
+
while (index > 0) {
|
|
150
|
+
const previous = line[index - 1];
|
|
151
|
+
const whitespace = previous.content.match(TRAILING_SPACE)?.[0];
|
|
152
|
+
if (!whitespace) {
|
|
153
|
+
break;
|
|
154
|
+
}
|
|
155
|
+
previous.content = previous.content.slice(0, -whitespace.length);
|
|
156
|
+
token.content = whitespace + token.content;
|
|
157
|
+
token.offset -= whitespace.length;
|
|
158
|
+
if (previous.content) {
|
|
159
|
+
break;
|
|
160
|
+
}
|
|
161
|
+
line.splice(index - 1, 1);
|
|
162
|
+
index--;
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
};
|
|
166
|
+
|
|
167
|
+
const tokenize = (code, options) => {
|
|
168
|
+
const result = codeToTokens(code, {
|
|
169
|
+
lang: resolveLang(options.lang),
|
|
170
|
+
themes: { light: geistHighlightsTheme },
|
|
171
|
+
defaultColor: "light",
|
|
172
|
+
cssVariablePrefix: "--shiki-",
|
|
173
|
+
});
|
|
174
|
+
// Highlights colors unstyled runs with `var(--shiki-foreground)`; Shiki uses
|
|
175
|
+
// the theme foreground, which Geist defines as `--shiki-color-text`.
|
|
176
|
+
for (const line of result.tokens) {
|
|
177
|
+
joinCommentWhitespace(line);
|
|
178
|
+
for (const token of line) {
|
|
179
|
+
if (token.htmlStyle?.color === UNSTYLED) {
|
|
180
|
+
token.htmlStyle = { ...token.htmlStyle, color: result.fg };
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
return {
|
|
185
|
+
tokens: result.tokens,
|
|
186
|
+
fg: result.fg,
|
|
187
|
+
bg: result.bg,
|
|
188
|
+
themeName: "shiki-themes geist",
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* A minimal Shiki highlighter: enough of the API for `@shikijs/rehype/core`.
|
|
194
|
+
* Mirrors Shiki's `codeToHast` (preprocess → tokens → token transformers →
|
|
195
|
+
* `tokensToHast`), swapping the tokenizer for Highlights.
|
|
196
|
+
*/
|
|
197
|
+
export const highlightsShikiAdapter = {
|
|
198
|
+
getLoadedLanguages: () => [],
|
|
199
|
+
loadLanguage: async () => undefined,
|
|
200
|
+
codeToTokens: (code, options) => tokenize(code, options),
|
|
201
|
+
codeToHast(code, options) {
|
|
202
|
+
const transformers = getTransformers(options);
|
|
203
|
+
const context = {
|
|
204
|
+
meta: {},
|
|
205
|
+
options,
|
|
206
|
+
codeToHast: (c, o) => highlightsShikiAdapter.codeToHast(c, o),
|
|
207
|
+
codeToTokens: (c, o) => tokenize(c, o),
|
|
208
|
+
};
|
|
209
|
+
|
|
210
|
+
let input = code;
|
|
211
|
+
for (const transformer of transformers) {
|
|
212
|
+
input = transformer.preprocess?.call(context, input, options) || input;
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
let { tokens, fg, bg, themeName } = tokenize(input, options);
|
|
216
|
+
const contextSource = {
|
|
217
|
+
...context,
|
|
218
|
+
get source() {
|
|
219
|
+
return input;
|
|
220
|
+
},
|
|
221
|
+
};
|
|
222
|
+
for (const transformer of transformers) {
|
|
223
|
+
tokens = transformer.tokens?.call(contextSource, tokens) || tokens;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
return tokensToHast(
|
|
227
|
+
tokens,
|
|
228
|
+
{
|
|
229
|
+
...options,
|
|
230
|
+
fg,
|
|
231
|
+
bg,
|
|
232
|
+
themeName,
|
|
233
|
+
transformers: options.transformers,
|
|
234
|
+
},
|
|
235
|
+
contextSource
|
|
236
|
+
);
|
|
237
|
+
},
|
|
238
|
+
};
|
|
239
|
+
|
|
240
|
+
/** Drop-in for Fumadocs' `rehypeCode`, backed by @pierre/highlights. */
|
|
241
|
+
export const rehypeCodeHighlights = (userOptions = {}) => {
|
|
242
|
+
const options = { ...rehypeCodeDefaultOptions, ...userOptions };
|
|
243
|
+
const transformers = [...(options.transformers ?? [])];
|
|
244
|
+
|
|
245
|
+
// Same preprocessing as Fumadocs' rehypeCode.
|
|
246
|
+
transformers.unshift({
|
|
247
|
+
name: "rehype-code:pre-process",
|
|
248
|
+
preprocess(code, { meta }) {
|
|
249
|
+
if (meta && "__parsed_raw" in meta) {
|
|
250
|
+
meta.__raw = meta.__parsed_raw;
|
|
251
|
+
// biome-ignore lint/performance/noDelete: matches Fumadocs.
|
|
252
|
+
delete meta.__parsed_raw;
|
|
253
|
+
}
|
|
254
|
+
if (meta && options.filterMetaString) {
|
|
255
|
+
meta.__raw = options.filterMetaString(meta.__raw ?? "");
|
|
256
|
+
}
|
|
257
|
+
return code.replace(TRAILING_NEWLINE, "");
|
|
258
|
+
},
|
|
259
|
+
});
|
|
260
|
+
if (options.icon !== false) {
|
|
261
|
+
transformers.push(transformerIcon(options.icon));
|
|
262
|
+
}
|
|
263
|
+
if (options.tab !== false) {
|
|
264
|
+
transformers.push(transformerTab());
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
// `lazy` routes every language through `loadLanguage`, which is a no-op:
|
|
268
|
+
// Highlights bundles its lexers and unknown languages fall back to plain.
|
|
269
|
+
const transformer = rehypeShikiFromHighlighter(highlightsShikiAdapter, {
|
|
270
|
+
...options,
|
|
271
|
+
lazy: true,
|
|
272
|
+
transformers,
|
|
273
|
+
});
|
|
274
|
+
|
|
275
|
+
return async (tree, file) => {
|
|
276
|
+
await transformer(tree, file, () => undefined);
|
|
277
|
+
};
|
|
278
|
+
};
|
package/shared-theme.css
CHANGED
|
@@ -281,7 +281,13 @@ button:not(:disabled, [aria-disabled="true"]) {
|
|
|
281
281
|
}
|
|
282
282
|
}
|
|
283
283
|
|
|
284
|
-
@container (
|
|
284
|
+
@container (width < 961px) {
|
|
285
|
+
#nd-page {
|
|
286
|
+
max-width: none;
|
|
287
|
+
padding-inline: 1.5rem;
|
|
288
|
+
transform: none;
|
|
289
|
+
}
|
|
290
|
+
|
|
285
291
|
#nd-page > .text-gray-900:first-child {
|
|
286
292
|
display: none;
|
|
287
293
|
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
GeistdocsSourceConfigOptions as BaseOptions,
|
|
3
|
+
defineGeistdocsSourceConfig as defineBaseConfig,
|
|
4
|
+
} from "./dist/source-config.js";
|
|
5
|
+
|
|
6
|
+
export * from "./dist/source-config.js";
|
|
7
|
+
|
|
8
|
+
export interface GeistdocsSourceConfigOptions extends BaseOptions {
|
|
9
|
+
/** Public package only. Defaults to Highlights; false disables highlighting. */
|
|
10
|
+
highlighter?: "highlights" | "shiki" | false;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export declare const defineGeistdocsSourceConfig: (
|
|
14
|
+
options?: GeistdocsSourceConfigOptions
|
|
15
|
+
) => ReturnType<typeof defineBaseConfig>;
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import { rehypeCode } from "fumadocs-core/mdx-plugins";
|
|
2
|
+
import { rehypeCodeHighlights } from "./rehype-code-highlights.js";
|
|
3
|
+
import { defineGeistdocsSourceConfig as defineBaseConfig } from "./source-config.js";
|
|
4
|
+
|
|
5
|
+
// biome-ignore lint/performance/noBarrelFile: this package entry point reuses the already-loaded source config.
|
|
6
|
+
export * from "./source-config.js";
|
|
7
|
+
|
|
8
|
+
// Keep the shared source config on Shiki: the private product copies that
|
|
9
|
+
// entry point and must not acquire a dependency on Highlights.
|
|
10
|
+
export const defineGeistdocsSourceConfig = (options = {}) => {
|
|
11
|
+
const { highlighter = "highlights", ...config } = options;
|
|
12
|
+
if (!["highlights", "shiki", false].includes(highlighter)) {
|
|
13
|
+
throw new TypeError(`Unknown code highlighter: ${highlighter}`);
|
|
14
|
+
}
|
|
15
|
+
const result = defineBaseConfig(config);
|
|
16
|
+
const mdx = result.mdxOptions;
|
|
17
|
+
if (highlighter === false || config.mdxOptions?.rehypeCodeOptions === false) {
|
|
18
|
+
mdx.rehypeCodeOptions = false;
|
|
19
|
+
return result;
|
|
20
|
+
}
|
|
21
|
+
if (highlighter === "shiki") {
|
|
22
|
+
return result;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
const plugins = mdx.rehypePlugins;
|
|
26
|
+
if (typeof plugins === "function") {
|
|
27
|
+
// Let consumers remove or replace the default highlighter first. Only
|
|
28
|
+
// replace Shiki if their final pipeline still contains it.
|
|
29
|
+
mdx.rehypePlugins = (defaults) =>
|
|
30
|
+
plugins(defaults).map((entry) => {
|
|
31
|
+
const [plugin, pluginOptions] = Array.isArray(entry) ? entry : [entry];
|
|
32
|
+
return plugin === rehypeCode
|
|
33
|
+
? [rehypeCodeHighlights, pluginOptions]
|
|
34
|
+
: entry;
|
|
35
|
+
});
|
|
36
|
+
} else {
|
|
37
|
+
mdx.rehypePlugins = [
|
|
38
|
+
[rehypeCodeHighlights, mdx.rehypeCodeOptions],
|
|
39
|
+
...(plugins ?? []),
|
|
40
|
+
];
|
|
41
|
+
mdx.rehypeCodeOptions = false;
|
|
42
|
+
}
|
|
43
|
+
return result;
|
|
44
|
+
};
|
|
@@ -283,6 +283,18 @@ export const docs = defineDocs({
|
|
|
283
283
|
export default defineGeistdocsSourceConfig();
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
+
### Code highlighter (public package)
|
|
287
|
+
|
|
288
|
+
The public package uses [Highlights](https://diffs.com/highlights), which tokenizes code with WebAssembly lexers while keeping the JavaScript MDX compiler. Geist colors, titles, icons, tabs and `[!code ...]` annotations are preserved. Some token colors differ from Shiki, and unsupported languages render as plain text. To use Shiki's TextMate grammars instead, pass `highlighter: "shiki"`:
|
|
289
|
+
|
|
290
|
+
```ts title="source.config.ts"
|
|
291
|
+
export default defineGeistdocsSourceConfig({ highlighter: "shiki" });
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
Set `highlighter: false` or `mdxOptions.rehypeCodeOptions: false` to disable built-in highlighting when providing your own plugin. A `rehypePlugins` callback can also remove or replace Fumadocs' default highlighter without Highlights being added back.
|
|
295
|
+
|
|
296
|
+
The private package retains its existing Shiki pipeline. The `highlighter` option above is available only in the public package.
|
|
297
|
+
|
|
286
298
|
To serve docs from the site root, use `route: "/"` in `content` and `baseUrl: "/"` in `createSource`. Root-mounted docs need explicit `markdownRoutes`; Geistdocs does not infer a broad `/*path` mapping because it can capture homepages and non-docs app routes.
|
|
287
299
|
|
|
288
300
|
## Page URLs
|
package/template/package.json
CHANGED
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@streamdown/code": "^1.0.1",
|
|
18
18
|
"@vercel/agent-readability": "^0.7.0",
|
|
19
19
|
"@vercel/analytics": "^1.6.1",
|
|
20
|
-
"@vercel/geistdocs": "2.15.
|
|
20
|
+
"@vercel/geistdocs": "2.15.4-canary.0faac50",
|
|
21
21
|
"@vercel/speed-insights": "^1.3.1",
|
|
22
22
|
"ai": "^6.0.132",
|
|
23
23
|
"clsx": "^2.1.1",
|