boltdocs 2.7.11 → 2.8.1

package/README.md

@@ -1,7 +1,3 @@
-<p align="center">
-  <img src="assets/light.svg" width="20%" alt="Boltdocs" />
-</p>
-
 <h1 align="center">Boltdocs</h1>
 
 <p align="center">
@@ -127,7 +123,7 @@ boltdocs doctor --check-external  # Verify external links too
 - **Broken internal link detection** — finds links pointing to non-existent files
 - **Missing metadata warnings** — flags pages without titles in frontmatter
 - **Orphaned translation detection** — identifies missing locale counterparts
-- **Performance budgets** — upcoming: set thresholds for build time and bundle size
+- **Performance budgets** — `boltdocs doctor --budget` checks JS/CSS/HTML size, image assets, and build time against configurable thresholds in `doctor.json`
 
 ### 🔌 Plugin System
 
@@ -180,25 +176,6 @@ export default defineConfig({
 
 ---
 
-## Tech Stack
-
-| Layer | Technology |
-|-------|------------|
-| **Runtime** | Node.js 18+ |
-| **Language** | TypeScript 5.9 |
-| **UI Library** | React 19 |
-| **Bundler** | Vite 7 / 8 |
-| **Styling** | Tailwind CSS v4 |
-| **SSG** | `@bdocs/ssg` (built on React Router 7) |
-| **MDX** | `@mdx-js/rollup` 3.1 |
-| **Syntax Highlighting** | Shiki 3.23 |
-| **Search** | FlexSearch 0.8 |
-| **CLI** | cac 7 (command-line parser) |
-| **Testing** | Vitest |
-| **Build System** | Turborepo + pnpm workspaces |
-
----
-
 ## CLI Commands
 
 | Command | Description |
@@ -208,36 +185,7 @@ export default defineConfig({
 | `boltdocs preview` | Preview the production build locally |
 | `boltdocs doctor` | Run health checks on your documentation |
 | `boltdocs changelog <file>` | Generate versioned changelog pages from CHANGELOG.md |
-
----
-
-## Ecosystem
-
-| Package | npm | Description |
-|---------|-----|-------------|
-| **boltdocs** | [npm](https://www.npmjs.com/package/boltdocs) | Core framework (this package) |
-| **@bdocs/ssg** | [npm](https://www.npmjs.com/package/@bdocs/ssg) | Standalone SSG engine for React Router |
-| **@bdocs/plugin-mermaid** | [npm](https://www.npmjs.com/package/@bdocs/plugin-mermaid) | Mermaid diagram plugin |
-| **create-boltdocs** | [npm](https://www.npmjs.com/package/create-boltdocs) | Project scaffolding tool |
-
----
-
-## Roadmap
-
-- [x] Incremental builds
-- [ ] RSS / Atom feed
-- [ ] Blog (posts, tags, authors, pagination)
-- [ ] Drafts / preview mode
-- [ ] AI search (semantic RAG)
-- [ ] Partial hydration / islands architecture
-- [ ] Streaming SSR in dev
-- [ ] OpenAPI / Swagger with interactive playground
-- [ ] Multi-instance docs
-- [ ] Performance budgets in Doctor
-- [ ] Preconnect / DNS-prefetch automation
-- [ ] Distributed build farm
-
-See [ROADMAP.md](ROADMAP.md) for details.
+| `boltdocs audit` | Audit plugin dependencies for security warnings |
 
 ---
 

package/dist/banner-3N4Jd_L9.d.ts

@@ -0,0 +1,100 @@
+
+import { T as BoltdocsConfig, a as SidebarItem, d as SidebarMobile, f as SidebarRoot, i as SidebarHeader, l as SidebarLink, n as SidebarContent, p as SidebarSubGroup, r as SidebarGroup, s as SidebarItems, v as ComponentRoute, x as OnThisPageProps } from "./sidebar-DNq4_ZAa.js";
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/client/components/ui-base/navbar.d.ts
+declare function Navbar(): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/sidebar.d.ts
+interface SidebarProps {
+  routes: ComponentRoute[];
+  config: BoltdocsConfig;
+}
+declare function SidebarMain({
+  routes,
+  config
+}: SidebarProps): _$react_jsx_runtime0.JSX.Element;
+declare const Sidebar: typeof SidebarMain & {
+  Root: typeof SidebarRoot;
+  Mobile: typeof SidebarMobile;
+  Header: typeof SidebarHeader;
+  Content: typeof SidebarContent;
+  Group: typeof SidebarGroup;
+  Link: typeof SidebarLink;
+  SubGroup: typeof SidebarSubGroup;
+  Item: typeof SidebarItem;
+  Items: typeof SidebarItems;
+};
+//#endregion
+//#region src/client/components/ui-base/on-this-page.d.ts
+declare function OnThisPage({
+  headings,
+  editLink,
+  communityHelp,
+  filePath
+}: OnThisPageProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/breadcrumbs.d.ts
+declare function Breadcrumbs(): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/page-nav.d.ts
+/**
+ * Component to display the previous and next page navigation buttons.
+ * Enhanced with subtle entrance animations, modern card layout, and hover highlights.
+ */
+declare function PageNav(): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/error-boundary.d.ts
+interface ErrorBoundaryProps {
+  children?: ReactNode;
+  fallback?: ReactNode;
+}
+declare function ErrorBoundary({
+  children,
+  fallback
+}: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/copy-markdown.d.ts
+interface CopyMarkdownProps {
+  content?: string;
+  mdxRaw?: string;
+  route?: ComponentRoute;
+}
+declare function CopyMarkdown({
+  content,
+  mdxRaw
+}: CopyMarkdownProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/search-dialog.d.ts
+declare function SearchDialog({
+  routes
+}: {
+  routes: ComponentRoute[];
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/not-found.d.ts
+declare function NotFound(): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/banner.d.ts
+interface BannerProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * If true, shows a close button to dismiss the banner.
+   */
+  dismissible?: boolean;
+  /**
+   * Unique identifier for the banner. If provided and dismissible is true,
+   * the dismissed state will be saved in localStorage so it doesn't reappear
+   * on subsequent visits.
+   */
+  id?: string;
+}
+declare function Banner({
+  children,
+  className,
+  dismissible,
+  id,
+  ...props
+}: BannerProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { ErrorBoundary as a, OnThisPage as c, CopyMarkdown as i, Sidebar as l, NotFound as n, PageNav as o, SearchDialog as r, Breadcrumbs as s, Banner as t, Navbar as u };

package/dist/banner-MynZD_Ox.d.cts

@@ -0,0 +1,100 @@
+
+import { T as BoltdocsConfig, a as SidebarItem, d as SidebarMobile, f as SidebarRoot, i as SidebarHeader, l as SidebarLink, n as SidebarContent, p as SidebarSubGroup, r as SidebarGroup, s as SidebarItems, v as ComponentRoute, x as OnThisPageProps } from "./sidebar-Dlkgbxs6.cjs";
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/client/components/ui-base/navbar.d.ts
+declare function Navbar(): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/sidebar.d.ts
+interface SidebarProps {
+  routes: ComponentRoute[];
+  config: BoltdocsConfig;
+}
+declare function SidebarMain({
+  routes,
+  config
+}: SidebarProps): _$react_jsx_runtime0.JSX.Element;
+declare const Sidebar: typeof SidebarMain & {
+  Root: typeof SidebarRoot;
+  Mobile: typeof SidebarMobile;
+  Header: typeof SidebarHeader;
+  Content: typeof SidebarContent;
+  Group: typeof SidebarGroup;
+  Link: typeof SidebarLink;
+  SubGroup: typeof SidebarSubGroup;
+  Item: typeof SidebarItem;
+  Items: typeof SidebarItems;
+};
+//#endregion
+//#region src/client/components/ui-base/on-this-page.d.ts
+declare function OnThisPage({
+  headings,
+  editLink,
+  communityHelp,
+  filePath
+}: OnThisPageProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/breadcrumbs.d.ts
+declare function Breadcrumbs(): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/page-nav.d.ts
+/**
+ * Component to display the previous and next page navigation buttons.
+ * Enhanced with subtle entrance animations, modern card layout, and hover highlights.
+ */
+declare function PageNav(): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/error-boundary.d.ts
+interface ErrorBoundaryProps {
+  children?: ReactNode;
+  fallback?: ReactNode;
+}
+declare function ErrorBoundary({
+  children,
+  fallback
+}: ErrorBoundaryProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/copy-markdown.d.ts
+interface CopyMarkdownProps {
+  content?: string;
+  mdxRaw?: string;
+  route?: ComponentRoute;
+}
+declare function CopyMarkdown({
+  content,
+  mdxRaw
+}: CopyMarkdownProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+//#region src/client/components/ui-base/search-dialog.d.ts
+declare function SearchDialog({
+  routes
+}: {
+  routes: ComponentRoute[];
+}): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/not-found.d.ts
+declare function NotFound(): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/client/components/ui-base/banner.d.ts
+interface BannerProps extends React.HTMLAttributes<HTMLDivElement> {
+  /**
+   * If true, shows a close button to dismiss the banner.
+   */
+  dismissible?: boolean;
+  /**
+   * Unique identifier for the banner. If provided and dismissible is true,
+   * the dismissed state will be saved in localStorage so it doesn't reappear
+   * on subsequent visits.
+   */
+  id?: string;
+}
+declare function Banner({
+  children,
+  className,
+  dismissible,
+  id,
+  ...props
+}: BannerProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { ErrorBoundary as a, OnThisPage as c, CopyMarkdown as i, Sidebar as l, NotFound as n, PageNav as o, SearchDialog as r, Breadcrumbs as s, Banner as t, Navbar as u };

package/dist/cache-BMUyNiiA.mjs

@@ -0,0 +1,6 @@
+/**
+ * Boltdocs - https://boltdocs.vercel.app
+ * Copyright (c) 2026 Jesus Alcala
+ * Licensed under the MIT License.
+ */
+import{o as e,s as t}from"./utils-BYITg7T5.mjs";import n from"node:path";import r from"node:fs";import i from"node:fs/promises";import a from"node:crypto";import o from"node:zlib";import{promisify as s}from"node:util";import{LRUCache as c}from"lru-cache";const l=i.writeFile,u=i.readFile,d=i.mkdir,f=i.rename,p=s(o.gzip),m=s(o.gunzip),h=new class{activeTasks=new Set;add(e){let t=Promise.resolve().then(e).catch(()=>{}).finally(()=>{this.activeTasks.delete(t)});this.activeTasks.add(t)}async flush(){await Promise.all(Array.from(this.activeTasks))}get pending(){return this.activeTasks.size}};var g=class{entries=new Map;cachePath=null;compress;constructor(t={}){let r=e();if(this.compress=t.compress===void 0?r.compress:t.compress,t.name){let e=t.root||process.cwd(),i=this.compress?`json.gz`:`json`;this.cachePath=n.resolve(e,r.dir,`${t.name}.${i}`)}}async load(){if(!e().noCache&&this.cachePath)try{let e=await u(this.cachePath);this.cachePath.endsWith(`.gz`)&&(e=await m(e));let t=JSON.parse(e.toString(`utf-8`));this.entries=new Map(Object.entries(t))}catch(e){if(e.code===`ENOENT`)return}}save(){if(e().noCache||!this.cachePath)return;let t=Object.fromEntries(this.entries),r=JSON.stringify(t),i=this.cachePath,o=this.compress;h.add(async()=>{try{await d(n.dirname(i),{recursive:!0});let e=Buffer.from(r);o&&(e=await p(e));let t=`${i}.${a.randomBytes(4).toString(`hex`)}.tmp`;await l(t,e),await f(t,i)}catch{}})}get(e){let n=this.entries.get(e);return!n||t(e)!==n.mtime?null:n.data}set(e,n){this.entries.set(e,{data:n,mtime:t(e)})}isValid(e){let n=this.entries.get(e);return n?t(e)===n.mtime:!1}invalidate(e){this.entries.delete(e)}invalidateAll(){this.entries.clear()}pruneStale(e){for(let t of this.entries.keys())e.has(t)||this.entries.delete(t)}get size(){return this.entries.size}async flush(){await h.flush()}},_=class{index=new Map;memoryCache;baseDir;shardsDir;indexPath;constructor(t,r=process.cwd()){let i=e();this.baseDir=n.resolve(r,i.dir,`transform-${t}`),this.shardsDir=n.resolve(this.baseDir,`shards`),this.indexPath=n.resolve(this.baseDir,`index.json`),this.memoryCache=new c({max:i.lruLimit,ttl:i.lruTTL,updateAgeOnGet:!0})}async load(){if(!e().noCache)try{let e=await u(this.indexPath,`utf-8`);this.index=new Map(Object.entries(JSON.parse(e)))}catch(e){if(e.code===`ENOENT`)return}}save(){if(e().noCache)return;let t=JSON.stringify(Object.fromEntries(this.index)),r=this.indexPath;h.add(async()=>{try{await d(n.dirname(r),{recursive:!0}),await l(r,t)}catch{}})}async getMany(e){let t=new Map,r=[];for(let n of e){let e=this.memoryCache.get(n);e?t.set(n,e):this.index.has(n)&&r.push(n)}if(r.length>0){let e=await Promise.all(r.map(async e=>{let t=this.index.get(e),r=n.resolve(this.shardsDir,`${t}.gz`);try{let t=(await m(await u(r))).toString(`utf-8`);return this.memoryCache.set(e,t),{key:e,val:t}}catch{return null}}));for(let n of e)n&&t.set(n.key,n.val)}return t}async getAsync(e){let t=this.memoryCache.get(e);if(t)return t;let r=this.index.get(e);if(!r)return null;let i=n.resolve(this.shardsDir,`${r}.gz`);try{let t=(await m(await u(i))).toString(`utf-8`);return this.memoryCache.set(e,t),t}catch(e){return e.code,null}}set(e,t){let r=a.createHash(`md5`).update(t).digest(`hex`);this.index.set(e,r),this.memoryCache.set(e,t);let o=n.resolve(this.shardsDir,`${r}.gz`);h.add(async()=>{try{try{await i.access(o);return}catch{}await d(this.shardsDir,{recursive:!0});let e=await p(Buffer.from(t)),n=`${o}.${a.randomBytes(4).toString(`hex`)}.tmp`;await l(n,e),await f(n,o)}catch{}})}get size(){return this.index.size}async flush(){await h.flush()}};const v=new Map,y=()=>{let t=e();return n.resolve(process.cwd(),t.dir,`cache/parser`)},b=`v2.3`;var x=class{static async get(t){if(e().noCache)return null;try{let e=v.get(t);if(e)return e.data;let i=await r.promises.stat(t),o=y(),s=a.createHash(`md5`).update(t).digest(`hex`),c=n.join(o,`${s}.json`);try{let e=await r.promises.readFile(c,`utf-8`),n=JSON.parse(e);return n._mtime!==i.mtimeMs||n._v!==b?null:(v.set(t,{data:n.data,mtime:n._mtime}),n.data)}catch{return null}}catch{return null}}static async set(t,i){if(!e().noCache)try{let e=await r.promises.stat(t);v.set(t,{data:i,mtime:e.mtimeMs});let o=y(),s=a.createHash(`md5`).update(t).digest(`hex`),c=n.join(o,`${s}.json`),l={_v:b,_mtime:e.mtimeMs,data:i};h.add(async()=>{try{await r.promises.mkdir(o,{recursive:!0}),await r.promises.writeFile(c,JSON.stringify(l))}catch{}})}catch{}}static invalidate(e){v.delete(e)}static clear(){v.clear();let e=y();if(r.existsSync(e))try{r.rmSync(e,{recursive:!0,force:!0})}catch{}}};export{g as n,_ as r,x as t};

package/dist/cache-CKm45d2w.cjs

@@ -0,0 +1,6 @@
+/**
+ * Boltdocs - https://boltdocs.vercel.app
+ * Copyright (c) 2026 Jesus Alcala
+ * Licensed under the MIT License.
+ */
+const e=require(`./chunk-CU-zTemE.cjs`),t=require(`./utils-Cjmx1hhk.cjs`);let n=require(`node:path`);n=e.t(n);let r=require(`node:fs`);r=e.t(r);let i=require(`node:fs/promises`);i=e.t(i);let a=require(`node:crypto`);a=e.t(a);let o=require(`node:zlib`);o=e.t(o);let s=require(`node:util`),c=require(`lru-cache`);const l=i.default.writeFile,u=i.default.readFile,d=i.default.mkdir,f=i.default.rename,p=(0,s.promisify)(o.default.gzip),m=(0,s.promisify)(o.default.gunzip),h=new class{activeTasks=new Set;add(e){let t=Promise.resolve().then(e).catch(()=>{}).finally(()=>{this.activeTasks.delete(t)});this.activeTasks.add(t)}async flush(){await Promise.all(Array.from(this.activeTasks))}get pending(){return this.activeTasks.size}};var g=class{entries=new Map;cachePath=null;compress;constructor(e={}){let r=t.o();if(this.compress=e.compress===void 0?r.compress:e.compress,e.name){let t=e.root||process.cwd(),i=this.compress?`json.gz`:`json`;this.cachePath=n.default.resolve(t,r.dir,`${e.name}.${i}`)}}async load(){if(!t.o().noCache&&this.cachePath)try{let e=await u(this.cachePath);this.cachePath.endsWith(`.gz`)&&(e=await m(e));let t=JSON.parse(e.toString(`utf-8`));this.entries=new Map(Object.entries(t))}catch(e){if(e.code===`ENOENT`)return}}save(){if(t.o().noCache||!this.cachePath)return;let e=Object.fromEntries(this.entries),r=JSON.stringify(e),i=this.cachePath,o=this.compress;h.add(async()=>{try{await d(n.default.dirname(i),{recursive:!0});let e=Buffer.from(r);o&&(e=await p(e));let t=`${i}.${a.default.randomBytes(4).toString(`hex`)}.tmp`;await l(t,e),await f(t,i)}catch{}})}get(e){let n=this.entries.get(e);return!n||t.s(e)!==n.mtime?null:n.data}set(e,n){this.entries.set(e,{data:n,mtime:t.s(e)})}isValid(e){let n=this.entries.get(e);return n?t.s(e)===n.mtime:!1}invalidate(e){this.entries.delete(e)}invalidateAll(){this.entries.clear()}pruneStale(e){for(let t of this.entries.keys())e.has(t)||this.entries.delete(t)}get size(){return this.entries.size}async flush(){await h.flush()}},_=class{index=new Map;memoryCache;baseDir;shardsDir;indexPath;constructor(e,r=process.cwd()){let i=t.o();this.baseDir=n.default.resolve(r,i.dir,`transform-${e}`),this.shardsDir=n.default.resolve(this.baseDir,`shards`),this.indexPath=n.default.resolve(this.baseDir,`index.json`),this.memoryCache=new c.LRUCache({max:i.lruLimit,ttl:i.lruTTL,updateAgeOnGet:!0})}async load(){if(!t.o().noCache)try{let e=await u(this.indexPath,`utf-8`);this.index=new Map(Object.entries(JSON.parse(e)))}catch(e){if(e.code===`ENOENT`)return}}save(){if(t.o().noCache)return;let e=JSON.stringify(Object.fromEntries(this.index)),r=this.indexPath;h.add(async()=>{try{await d(n.default.dirname(r),{recursive:!0}),await l(r,e)}catch{}})}async getMany(e){let t=new Map,r=[];for(let n of e){let e=this.memoryCache.get(n);e?t.set(n,e):this.index.has(n)&&r.push(n)}if(r.length>0){let e=await Promise.all(r.map(async e=>{let t=this.index.get(e),r=n.default.resolve(this.shardsDir,`${t}.gz`);try{let t=(await m(await u(r))).toString(`utf-8`);return this.memoryCache.set(e,t),{key:e,val:t}}catch{return null}}));for(let n of e)n&&t.set(n.key,n.val)}return t}async getAsync(e){let t=this.memoryCache.get(e);if(t)return t;let r=this.index.get(e);if(!r)return null;let i=n.default.resolve(this.shardsDir,`${r}.gz`);try{let t=(await m(await u(i))).toString(`utf-8`);return this.memoryCache.set(e,t),t}catch(e){return e.code,null}}set(e,t){let r=a.default.createHash(`md5`).update(t).digest(`hex`);this.index.set(e,r),this.memoryCache.set(e,t);let o=n.default.resolve(this.shardsDir,`${r}.gz`);h.add(async()=>{try{try{await i.default.access(o);return}catch{}await d(this.shardsDir,{recursive:!0});let e=await p(Buffer.from(t)),n=`${o}.${a.default.randomBytes(4).toString(`hex`)}.tmp`;await l(n,e),await f(n,o)}catch{}})}get size(){return this.index.size}async flush(){await h.flush()}};const v=new Map,y=()=>{let e=t.o();return n.default.resolve(process.cwd(),e.dir,`cache/parser`)},b=`v2.3`;var x=class{static async get(e){if(t.o().noCache)return null;try{let t=v.get(e);if(t)return t.data;let i=await r.default.promises.stat(e),o=y(),s=a.default.createHash(`md5`).update(e).digest(`hex`),c=n.default.join(o,`${s}.json`);try{let t=await r.default.promises.readFile(c,`utf-8`),n=JSON.parse(t);return n._mtime!==i.mtimeMs||n._v!==b?null:(v.set(e,{data:n.data,mtime:n._mtime}),n.data)}catch{return null}}catch{return null}}static async set(e,i){if(!t.o().noCache)try{let t=await r.default.promises.stat(e);v.set(e,{data:i,mtime:t.mtimeMs});let o=y(),s=a.default.createHash(`md5`).update(e).digest(`hex`),c=n.default.join(o,`${s}.json`),l={_v:b,_mtime:t.mtimeMs,data:i};h.add(async()=>{try{await r.default.promises.mkdir(o,{recursive:!0}),await r.default.promises.writeFile(c,JSON.stringify(l))}catch{}})}catch{}}static invalidate(e){v.delete(e)}static clear(){v.clear();let e=y();if(r.default.existsSync(e))try{r.default.rmSync(e,{recursive:!0,force:!0})}catch{}}};Object.defineProperty(exports,`n`,{enumerable:!0,get:function(){return g}}),Object.defineProperty(exports,`r`,{enumerable:!0,get:function(){return _}}),Object.defineProperty(exports,`t`,{enumerable:!0,get:function(){return x}});