@baybreezy/docd 0.0.8 → 0.0.10

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Behon Baker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+# @baybreezy/docd
+
+> Build beautiful documentation sites with Nuxt, Markdown, and Vue components.
+
+[![npm version](https://img.shields.io/npm/v/@baybreezy/docd.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npmjs.com/package/@baybreezy/docd)
+[![npm downloads](https://img.shields.io/npm/dm/@baybreezy/docd.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npm.chart.dev/@baybreezy/docd)
+[![License](https://img.shields.io/npm/l/@baybreezy/docd.svg?style=flat&colorA=020420&colorB=EEEEEE)](https://npmjs.com/package/@baybreezy/docd)
+
+## Quick Start
+
+Scaffold a new project in seconds:
+
+```bash
+# Create a new docs project
+npx create-docd my-docs
+
+# Navigate to your project
+cd my-docs
+
+# Start the dev server
+bun run dev
+```
+
+Your documentation site will be running at `http://localhost:3000`.
+
+## What you get
+
+A fully configured documentation site with:
+
+- **Beautiful design** — Clean, modern theme built on [UI Thing](https://uithing.com) components
+- **Theming** — 17 color themes with light/dark mode out of the box
+- **Markdown enhanced** — Extended MDC syntax with interactive components and prose wrappers
+- **Component API docs** — Automatic prop/slot/event documentation from Vue component metadata
+- **Full-text search** — Built-in search across all your content
+- **OG images** — Automatic Open Graph image generation
+- **LLM-ready** — Auto-generates `llms.txt` and `llms-full.txt` for AI tool integration
+- **MCP server** — Built-in Model Context Protocol server for Cursor, VS Code, Claude, and more
+- **SEO** — Sitemap, robots.txt, and meta tags configured automatically
+- **TypeScript** — Full type safety throughout
+
+## Project structure
+
+```
+my-docs/
+├── content/              # Your Markdown content
+│   ├── index.md          # Homepage
+│   └── docs/             # Documentation pages
+├── public/               # Static assets
+└── package.json
+```
+
+Docd is a Nuxt layer — you can extend it with any standard Nuxt feature:
+
+```
+my-docs/
+├── nuxt.config.ts        # Extra modules and Nuxt configuration
+├── app/
+│   ├── app.config.ts     # Theme, navigation, and feature flags
+│   ├── components/       # Your own Vue components (usable in Markdown)
+│   ├── layouts/          # Custom layouts
+│   └── pages/            # Extra pages outside of content/
+└── server/               # Server-side code
+```
+
+## Configuration
+
+Most things are controlled through `app.config.ts`:
+
+```ts
+export default defineAppConfig({
+  docd: {
+    ui: {
+      toc: { title: "On this page", icon: "lucide:list" },
+      borderType: "dashed",
+      transition: {
+        name: "fade",
+        duration: 0.35,
+        easing: "easeOut",
+      },
+    },
+  },
+});
+```
+
+Full configuration reference: [docd.uithing.com](https://docd.uithing.com)
+
+## Built with
+
+- [Nuxt](https://nuxt.com) — web framework
+- [Nuxt Content](https://content.nuxt.com) — file-based content layer
+- [UI Thing](https://uithing.com) — component library
+- [Tailwind CSS](https://tailwindcss.com) — utility-first CSS
+- [Nuxt Image](https://image.nuxt.com) — optimised image handling
+- [nuxt-og-image](https://nuxtseo.com/og-image/getting-started/installation) — OG image generation
+- [nuxt-llms](https://github.com/nuxt-hub/nuxt-llms) — LLM file generation
+
+## License
+
+Published under the [MIT](./LICENSE.md) license.

package/modules/prose-component-meta.ts

@@ -4,8 +4,6 @@ import { addTemplate, createResolver, defineNuxtModule, logger, updateTemplates
 
 import {
   appendComponentApiBlocks,
-  builtInComponentApiItems,
-  isBuiltInProseDocFile,
   projectComponentApiConfig,
   warnForMissingComponentPaths,
   withAutoTitles,
@@ -84,21 +82,6 @@ export default defineNuxtModule({
         warn: (message: string) => log.warn(message),
       };
 
-      if (isBuiltInProseDocFile(event.content)) {
-        const { heading, items, explicit } = builtInComponentApiItems(event.content, context);
-
-        if (!items.length) {
-          return;
-        }
-
-        if (explicit) {
-          warnForMissingComponentPaths(event.content, items, context);
-        }
-
-        event.content = await appendComponentApiBlocks(event.content, items, heading);
-        return;
-      }
-
       const componentApi = projectComponentApiConfig(event.content);
 
       if (!componentApi || componentApi === false) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baybreezy/docd",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "description": "A Nuxt layer for building documentation sites with UI Thing.",
   "repository": {
     "type": "git",

package/utils/component-api-content.ts

@@ -1,19 +1,12 @@
 import { existsSync } from "node:fs";
-import { basename, extname } from "node:path";
 
 import { parseMarkdown } from "@nuxtjs/mdc/runtime";
 
 import {
-  BUILT_IN_PROSE_COMPONENT_API_REGISTRY,
   DEFAULT_COMPONENT_API_LAYOUT,
-  DEFAULT_COMPONENT_API_SECTIONS,
   componentLabelFromPath,
   componentNameFromPath,
-  inferredBuiltInProseComponentPathFromSlug,
   normalizeComponentApiConfig,
-  normalizeComponentApiLayout,
-  normalizeComponentApiSections,
-  type BuiltInComponentApiRegistryItem,
   type NormalizedComponentApiItem,
 } from "./component-api";
 import { resolveComponentApiSourcePath } from "./component-api-discovery";
@@ -103,62 +96,6 @@ export function withAutoTitles(items: NormalizedComponentApiItem[]) {
   }));
 }
 
-function registryItemsToNormalizedItems(
-  items: readonly BuiltInComponentApiRegistryItem[],
-  defaults: Pick<NormalizedComponentApiItem, "layout" | "sections">
-) {
-  return items.map(
-    (item) =>
-      ({
-        path: item.path,
-        title: item.title,
-        layout: normalizeComponentApiLayout(item.layout, defaults.layout),
-        sections: normalizeComponentApiSections(item.sections, defaults.sections),
-      }) satisfies NormalizedComponentApiItem
-  );
-}
-
-function inferredItem(
-  slug: string,
-  defaults: Pick<NormalizedComponentApiItem, "layout" | "sections">,
-  context: ComponentApiTransformerContext
-) {
-  const inferredPath = inferredBuiltInProseComponentPathFromSlug(slug);
-  const resolvedPath = resolveComponentApiSourcePath({
-    rootDir: context.rootDir,
-    layerRoot: context.layerRoot,
-    path: inferredPath,
-  });
-
-  if (!existsSync(resolvedPath.absolutePath)) {
-    return [];
-  }
-
-  return [
-    {
-      path: inferredPath,
-      layout: defaults.layout,
-      sections: [...defaults.sections],
-    } satisfies NormalizedComponentApiItem,
-  ];
-}
-
-function defaultItemSettings(config: ReturnType<typeof normalizeComponentApiConfig>) {
-  if (config && config !== false) {
-    return {
-      heading: config.heading,
-      layout: config.layout,
-      sections: config.sections,
-    };
-  }
-
-  return {
-    heading: undefined,
-    layout: DEFAULT_COMPONENT_API_LAYOUT,
-    sections: [...DEFAULT_COMPONENT_API_SECTIONS],
-  };
-}
-
 function buildComponentApiBlockSource(item: NormalizedComponentApiItem, title?: string) {
   const props = [`path="${escapeMdcProp(item.path)}"`];
 
@@ -314,67 +251,10 @@ function appendTocLinks(
   };
 }
 
-export function isBuiltInProseDocFile(file: ComponentApiTransformerContent) {
-  return /^docs\/4\.prose\/.+\.md$/i.test(fileId(file));
-}
-
-export function builtInProseDocSlug(file: ComponentApiTransformerContent) {
-  return basename(fileId(file), extname(fileId(file)));
-}
-
 export function projectComponentApiConfig(file: ComponentApiTransformerContent) {
   return normalizeComponentApiConfig(file.componentApi);
 }
 
-export function builtInComponentApiItems(
-  file: ComponentApiTransformerContent,
-  context: ComponentApiTransformerContext
-) {
-  const config = normalizeComponentApiConfig(file.componentApi);
-
-  if (config === false) {
-    return {
-      heading: undefined,
-      items: [] as NormalizedComponentApiItem[],
-      explicit: false,
-    };
-  }
-
-  if (config?.hasExplicitComponents) {
-    return {
-      heading: config.heading,
-      items: withAutoTitles(config.components),
-      explicit: true,
-    };
-  }
-
-  const slug = builtInProseDocSlug(file);
-  const defaults = defaultItemSettings(config);
-  const registryEntry = BUILT_IN_PROSE_COMPONENT_API_REGISTRY[slug];
-
-  if (registryEntry === false) {
-    return {
-      heading: defaults.heading,
-      items: [] as NormalizedComponentApiItem[],
-      explicit: false,
-    };
-  }
-
-  if (Array.isArray(registryEntry)) {
-    return {
-      heading: defaults.heading,
-      items: withAutoTitles(registryItemsToNormalizedItems(registryEntry, defaults)),
-      explicit: false,
-    };
-  }
-
-  return {
-    heading: defaults.heading,
-    items: inferredItem(slug, defaults, context),
-    explicit: false,
-  };
-}
-
 export function warnForMissingComponentPaths(
   file: ComponentApiTransformerContent,
   items: NormalizedComponentApiItem[],

package/utils/component-api.ts

@@ -36,25 +36,25 @@ export const BUILT_IN_PROSE_COMPONENT_API_REGISTRY: Record<
   false | readonly BuiltInComponentApiRegistryItem[]
 > = {
   field: [
-    { path: "app/components/content/prose/ProseField.global.vue" },
-    { path: "app/components/content/prose/ProseFieldGroup.global.vue" },
+    { path: "app/components/content/prose/ProseField.vue" },
+    { path: "app/components/content/prose/ProseFieldGroup.vue" },
   ],
   images: [
-    { path: "app/components/content/prose/ProseImg.global.vue" },
-    { path: "app/components/content/prose/ProseColorModeImage.global.vue" },
+    { path: "app/components/content/prose/ProseImg.vue" },
+    { path: "app/components/content/prose/ProseColorModeImage.vue" },
   ],
   "icon-list": [
-    { path: "app/components/content/prose/ProseIconList.global.vue" },
-    { path: "app/components/content/prose/ProseLi.global.vue" },
+    { path: "app/components/content/prose/ProseIconList.vue" },
+    { path: "app/components/content/prose/ProseLi.vue" },
   ],
   "package-manager": [
-    { path: "app/components/content/prose/ProsePmInstall.global.vue" },
-    { path: "app/components/content/prose/ProsePmRun.global.vue" },
-    { path: "app/components/content/prose/ProsePmX.global.vue" },
+    { path: "app/components/content/prose/ProsePmInstall.vue" },
+    { path: "app/components/content/prose/ProsePmRun.vue" },
+    { path: "app/components/content/prose/ProsePmX.vue" },
   ],
   steps: [
-    { path: "app/components/content/prose/ProseSteps.global.vue" },
-    { path: "app/components/content/prose/ProseStep.global.vue" },
+    { path: "app/components/content/prose/ProseSteps.vue" },
+    { path: "app/components/content/prose/ProseStep.vue" },
   ],
   "code-snippet": false,
   typography: false,
@@ -125,7 +125,7 @@ export function componentNameFromSlug(slug: string) {
 }
 
 export function inferredBuiltInProseComponentPathFromSlug(slug: string) {
-  return `${BUILT_IN_PROSE_COMPONENT_ROOT}${componentNameFromSlug(slug)}.global.vue`;
+  return `${BUILT_IN_PROSE_COMPONENT_ROOT}${componentNameFromSlug(slug)}.vue`;
 }
 
 export function normalizeComponentApiLayout(