DreamLake

Package exports

@dreamlake/dockit exposes six entry points for configuration, rendering, build integration, and styles.

The exports map

EntryUsed fromPurpose
@dreamlake/dockitsite.config.ts, custom componentsThe library root: initDocs, components, hooks, data APIs.
@dreamlake/dockit/serverrenderer/+onRenderHtml.tsxThe onRenderHtml Vike hook — SSR HTML, head tags, fonts, FOUC script.
@dreamlake/dockit/clientrenderer/+onRenderClient.tsxThe onRenderClient hook — hydration + client routing renders.
@dreamlake/dockit/vikerenderer/+config.tsThe Vike page config (passToClient, clientRouting, prerender).
@dreamlake/dockit/vitevite.config.tsThe dockit() plugin factory — Tailwind, MDX, shiki, React, Vike.
@dreamlake/dockit/styles.cssstyles/app.cssTheme tokens, dark mode, shell CSS (import after tailwindcss).

Root export contents

InitializationinitDocs, plus the piecemeal setters: defineSiteConfig, initNavigation, initSearchIndex, initTabs.

Config + data singletonssiteConfig, pages, groupedPages, groupedVisiblePages, TABS, searchIndex, rawMarkdown.

Navigation + search APIsgetAdjacentPages, tabForUrl, urlInTab, normalizePath, findPage, internalTabs, isExternalTab, search (dev fallback), searchPages (pagefind-first), defaultResults.

ComponentsCallout, Chip, CodeBlock, Preview, StatusTable + TestStatus, TabStrip, DocFooter, ThemeToggle + ThemeProvider (see Theming), SearchPalette, Sidebar, TOC, Topbar, VersionBadge, SearchResizeHandles, ClientOnly, and the mdxComponents map (headings, links, tables, pre/code, plus Callout / Chip / Preview / StatusTable / TestStatus in MDX scope).

ShellLayout and useMerge (the H1-merge context).

HooksuseTheme, useHiddenToggle, useLineNumbers, useLocalStorage (+ docKey, DOC_PREFIX), useMediaQuery, useSearchResize.

TypesSiteConfig, VersionChip, InitDocsOptions, PageMeta, PageFrontmatter, NavGroup, TabDef, SearchEntry, SearchHit, SearchResult, SubResult, PreviewProps, ChipProps, ChipVariant, Theme, SearchConfig, MergeIndexDef, ExternalTabDef, TabEntry, PageModule, VersionBadgeProps.

Module shape

  • Pure ESM ("type": "module"), unbundled (preserveModules) with .d.ts beside every module — tree-shakes cleanly and steps through readable sources.
  • No source maps ship in the package.
  • sideEffects marks only CSS, so bundlers may drop any unused JS.
Why the renderer wrappers exist

Vike discovers hooks by +-prefixed filenames, which cannot live in node_modules — so your site owns three one-line files re-exporting /server, /client, and /vike. See the Quickstart.