@barodoc/core 1.0.1 → 3.0.0

package/dist/{chunk-SX42YS3W.js → chunk-633IEUDI.js}

@@ -36,6 +36,28 @@ var searchSchema = z.object({
   enabled: z.boolean().optional()
 }).optional();
 var lineNumbersSchema = z.boolean().optional();
+var editLinkSchema = z.object({
+  baseUrl: z.string()
+}).optional();
+var announcementSchema = z.object({
+  text: z.string(),
+  link: z.string().optional(),
+  dismissible: z.boolean().optional()
+}).optional();
+var feedbackSchema = z.object({
+  enabled: z.boolean(),
+  endpoint: z.string().optional()
+}).optional();
+var docsFrontmatterSchema = z.object({
+  title: z.string().optional(),
+  description: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+  related: z.array(z.string()).optional(),
+  category: z.string().optional(),
+  api_reference: z.boolean().optional(),
+  difficulty: z.enum(["beginner", "intermediate", "advanced"]).optional(),
+  lastUpdated: z.date().optional()
+});
 var pluginConfigSchema = z.union([
   z.string(),
   z.tuple([z.string(), z.record(z.unknown())])
@@ -44,12 +66,18 @@ var barodocConfigSchema = z.object({
   name: z.string(),
   logo: z.string().optional(),
   favicon: z.string().optional(),
+  site: z.string().optional(),
+  base: z.string().optional(),
   theme: themeConfigSchema,
   i18n: i18nConfigSchema,
   navigation: z.array(navItemSchema),
   topbar: topbarSchema,
   search: searchSchema,
   lineNumbers: lineNumbersSchema,
+  editLink: editLinkSchema,
+  lastUpdated: z.boolean().optional(),
+  announcement: announcementSchema,
+  feedback: feedbackSchema,
   plugins: z.array(pluginConfigSchema).optional(),
   customCss: z.array(z.string()).optional()
 });
@@ -104,6 +132,7 @@ function getConfigDefaults() {
 }
 
 export {
+  docsFrontmatterSchema,
   barodocConfigSchema,
   loadConfig,
   getConfigDefaults

package/dist/config/index.d.ts

@@ -1,11 +1,43 @@
 import { z } from 'zod';
-import { R as ResolvedBarodocConfig, a as BarodocConfig } from '../types-Be4n5fTN.js';
+import { R as ResolvedBarodocConfig, a as BarodocConfig } from '../types-EzD7o05V.js';
 import 'astro';
 
+/** Frontmatter schema for MDX/MD content files. Reusable across custom and quick mode. */
+declare const docsFrontmatterSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    related: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    category: z.ZodOptional<z.ZodString>;
+    api_reference: z.ZodOptional<z.ZodBoolean>;
+    difficulty: z.ZodOptional<z.ZodEnum<["beginner", "intermediate", "advanced"]>>;
+    lastUpdated: z.ZodOptional<z.ZodDate>;
+}, "strip", z.ZodTypeAny, {
+    title?: string | undefined;
+    description?: string | undefined;
+    tags?: string[] | undefined;
+    related?: string[] | undefined;
+    category?: string | undefined;
+    api_reference?: boolean | undefined;
+    difficulty?: "beginner" | "intermediate" | "advanced" | undefined;
+    lastUpdated?: Date | undefined;
+}, {
+    title?: string | undefined;
+    description?: string | undefined;
+    tags?: string[] | undefined;
+    related?: string[] | undefined;
+    category?: string | undefined;
+    api_reference?: boolean | undefined;
+    difficulty?: "beginner" | "intermediate" | "advanced" | undefined;
+    lastUpdated?: Date | undefined;
+}>;
+type DocsFrontmatter = z.infer<typeof docsFrontmatterSchema>;
 declare const barodocConfigSchema: z.ZodObject<{
     name: z.ZodString;
     logo: z.ZodOptional<z.ZodString>;
     favicon: z.ZodOptional<z.ZodString>;
+    site: z.ZodOptional<z.ZodString>;
+    base: z.ZodOptional<z.ZodString>;
     theme: z.ZodOptional<z.ZodObject<{
         colors: z.ZodOptional<z.ZodObject<{
             primary: z.ZodOptional<z.ZodString>;
@@ -123,6 +155,37 @@ declare const barodocConfigSchema: z.ZodObject<{
         enabled?: boolean | undefined;
     }>>;
     lineNumbers: z.ZodOptional<z.ZodBoolean>;
+    editLink: z.ZodOptional<z.ZodObject<{
+        baseUrl: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        baseUrl: string;
+    }, {
+        baseUrl: string;
+    }>>;
+    lastUpdated: z.ZodOptional<z.ZodBoolean>;
+    announcement: z.ZodOptional<z.ZodObject<{
+        text: z.ZodString;
+        link: z.ZodOptional<z.ZodString>;
+        dismissible: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        text: string;
+        link?: string | undefined;
+        dismissible?: boolean | undefined;
+    }, {
+        text: string;
+        link?: string | undefined;
+        dismissible?: boolean | undefined;
+    }>>;
+    feedback: z.ZodOptional<z.ZodObject<{
+        enabled: z.ZodBoolean;
+        endpoint: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        endpoint?: string | undefined;
+    }, {
+        enabled: boolean;
+        endpoint?: string | undefined;
+    }>>;
     plugins: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>], null>]>, "many">>;
     customCss: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
@@ -131,8 +194,11 @@ declare const barodocConfigSchema: z.ZodObject<{
         group: z.ZodString;
         pages: z.ZodArray<z.ZodString, "many">;
     }, z.ZodTypeAny, "passthrough">[];
+    lastUpdated?: boolean | undefined;
     logo?: string | undefined;
     favicon?: string | undefined;
+    site?: string | undefined;
+    base?: string | undefined;
     theme?: {
         colors?: {
             primary?: string | undefined;
@@ -164,6 +230,18 @@ declare const barodocConfigSchema: z.ZodObject<{
         enabled?: boolean | undefined;
     } | undefined;
     lineNumbers?: boolean | undefined;
+    editLink?: {
+        baseUrl: string;
+    } | undefined;
+    announcement?: {
+        text: string;
+        link?: string | undefined;
+        dismissible?: boolean | undefined;
+    } | undefined;
+    feedback?: {
+        enabled: boolean;
+        endpoint?: string | undefined;
+    } | undefined;
     plugins?: (string | [string, Record<string, unknown>])[] | undefined;
     customCss?: string[] | undefined;
 }, {
@@ -172,8 +250,11 @@ declare const barodocConfigSchema: z.ZodObject<{
         group: z.ZodString;
         pages: z.ZodArray<z.ZodString, "many">;
     }, z.ZodTypeAny, "passthrough">[];
+    lastUpdated?: boolean | undefined;
     logo?: string | undefined;
     favicon?: string | undefined;
+    site?: string | undefined;
+    base?: string | undefined;
     theme?: {
         colors?: {
             primary?: string | undefined;
@@ -205,6 +286,18 @@ declare const barodocConfigSchema: z.ZodObject<{
         enabled?: boolean | undefined;
     } | undefined;
     lineNumbers?: boolean | undefined;
+    editLink?: {
+        baseUrl: string;
+    } | undefined;
+    announcement?: {
+        text: string;
+        link?: string | undefined;
+        dismissible?: boolean | undefined;
+    } | undefined;
+    feedback?: {
+        enabled: boolean;
+        endpoint?: string | undefined;
+    } | undefined;
     plugins?: (string | [string, Record<string, unknown>])[] | undefined;
     customCss?: string[] | undefined;
 }>;
@@ -214,4 +307,4 @@ type BarodocConfigOutput = z.output<typeof barodocConfigSchema>;
 declare function loadConfig(configPath: string, root: string): Promise<ResolvedBarodocConfig>;
 declare function getConfigDefaults(): Partial<BarodocConfig>;
 
-export { type BarodocConfigInput, type BarodocConfigOutput, barodocConfigSchema, getConfigDefaults, loadConfig };
+export { type BarodocConfigInput, type BarodocConfigOutput, type DocsFrontmatter, barodocConfigSchema, docsFrontmatterSchema, getConfigDefaults, loadConfig };

package/dist/config/index.js

@@ -1,10 +1,12 @@
 import {
   barodocConfigSchema,
+  docsFrontmatterSchema,
   getConfigDefaults,
   loadConfig
-} from "../chunk-SX42YS3W.js";
+} from "../chunk-633IEUDI.js";
 export {
   barodocConfigSchema,
+  docsFrontmatterSchema,
   getConfigDefaults,
   loadConfig
 };

package/dist/i18n/index.d.ts

@@ -1,4 +1,4 @@
-import { b as BarodocI18nConfig, c as BarodocNavItem } from '../types-Be4n5fTN.js';
+import { b as BarodocI18nConfig, c as BarodocNavItem } from '../types-EzD7o05V.js';
 import 'astro';
 
 declare function getLocaleFromPath(path: string, i18n: BarodocI18nConfig): string;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AstroIntegration } from 'astro';
-import { B as BarodocOptions } from './types-Be4n5fTN.js';
-export { a as BarodocConfig, b as BarodocI18nConfig, c as BarodocNavItem, d as BarodocPlugin, e as BarodocPluginFactory, f as BarodocPluginHooks, g as BarodocThemeColors, h as BarodocThemeConfig, i as BuildContext, C as ContentContext, P as PluginConfig, j as PluginContext, R as ResolvedBarodocConfig, k as ResolvedPlugin, T as ThemeExport } from './types-Be4n5fTN.js';
-export { barodocConfigSchema, loadConfig } from './config/index.js';
+import { B as BarodocOptions } from './types-EzD7o05V.js';
+export { a as BarodocConfig, b as BarodocI18nConfig, c as BarodocNavItem, d as BarodocPlugin, e as BarodocPluginFactory, f as BarodocPluginHooks, g as BarodocThemeColors, h as BarodocThemeConfig, i as BuildContext, C as ContentContext, P as PluginConfig, j as PluginContext, R as ResolvedBarodocConfig, k as ResolvedPlugin, T as ThemeExport } from './types-EzD7o05V.js';
+export { DocsFrontmatter, barodocConfigSchema, docsFrontmatterSchema, loadConfig } from './config/index.js';
 export { getLocaleFromPath, getLocaleLabel, getLocalizedNavGroup, getLocalizedPath, removeLocaleFromPath } from './i18n/index.js';
 export { definePlugin, getPluginIntegrations, loadPlugins, runConfigHook, runHook } from './plugins/index.js';
 import 'zod';

package/dist/index.js

@@ -1,7 +1,8 @@
 import {
   barodocConfigSchema,
+  docsFrontmatterSchema,
   loadConfig
-} from "./chunk-SX42YS3W.js";
+} from "./chunk-633IEUDI.js";
 import {
   getLocaleFromPath,
   getLocaleLabel,
@@ -18,6 +19,8 @@ import {
 } from "./chunk-UICDSNBG.js";
 
 // src/integration.ts
+import { existsSync } from "fs";
+import { join } from "path";
 var VIRTUAL_CONFIG_ID = "virtual:barodoc/config";
 var VIRTUAL_I18N_ID = "virtual:barodoc/i18n";
 function resolveVirtualId(id) {
@@ -86,9 +89,20 @@ function barodoc(options) {
         };
         const themeIntegration = options.theme.integration(resolvedConfig);
         const pluginIntegrations = getPluginIntegrations(plugins, pluginContext);
+        const overridesDir = join(rootPath, "overrides");
+        const overridesAlias = {};
+        if (existsSync(join(overridesDir, "components"))) {
+          overridesAlias["@overrides/components"] = join(overridesDir, "components");
+          logger.info("Overrides: components/ detected");
+        }
+        if (existsSync(join(overridesDir, "layouts"))) {
+          overridesAlias["@overrides/layouts"] = join(overridesDir, "layouts");
+          logger.info("Overrides: layouts/ detected");
+        }
         updateConfig({
           vite: {
-            plugins: [createVirtualModulesPlugin(resolvedConfig)]
+            plugins: [createVirtualModulesPlugin(resolvedConfig)],
+            resolve: Object.keys(overridesAlias).length > 0 ? { alias: overridesAlias } : void 0
           },
           integrations: [themeIntegration, ...pluginIntegrations]
         });
@@ -106,6 +120,7 @@ export {
   barodocConfigSchema,
   barodoc as default,
   definePlugin,
+  docsFrontmatterSchema,
   getLocaleFromPath,
   getLocaleLabel,
   getLocalizedNavGroup,

package/dist/plugins/index.d.ts

@@ -1,5 +1,5 @@
-import { k as ResolvedPlugin, j as PluginContext, P as PluginConfig, R as ResolvedBarodocConfig, f as BarodocPluginHooks, d as BarodocPlugin } from '../types-Be4n5fTN.js';
-export { e as BarodocPluginFactory, i as BuildContext, C as ContentContext } from '../types-Be4n5fTN.js';
+import { k as ResolvedPlugin, j as PluginContext, P as PluginConfig, R as ResolvedBarodocConfig, f as BarodocPluginHooks, d as BarodocPlugin } from '../types-EzD7o05V.js';
+export { e as BarodocPluginFactory, i as BuildContext, C as ContentContext } from '../types-EzD7o05V.js';
 import * as astro from 'astro';
 
 /**

package/dist/{types-Be4n5fTN.d.ts → types-EzD7o05V.d.ts}

@@ -117,6 +117,8 @@ interface BarodocConfig {
     name: string;
     logo?: string;
     favicon?: string;
+    site?: string;
+    base?: string;
     theme?: BarodocThemeConfig;
     i18n?: BarodocI18nConfig;
     navigation: BarodocNavItem[];
@@ -130,6 +132,23 @@ interface BarodocConfig {
     };
     /** When true, code blocks render with line numbers. */
     lineNumbers?: boolean;
+    /** GitHub edit link base URL for "Edit this page" links. */
+    editLink?: {
+        baseUrl: string;
+    };
+    /** When true, shows git-based last updated timestamp on each page. */
+    lastUpdated?: boolean;
+    /** Top-of-page announcement banner. */
+    announcement?: {
+        text: string;
+        link?: string;
+        dismissible?: boolean;
+    };
+    /** Page feedback widget ("Was this helpful?"). */
+    feedback?: {
+        enabled: boolean;
+        endpoint?: string;
+    };
     plugins?: PluginConfig[];
     customCss?: string[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barodoc/core",
-  "version": "1.0.1",
+  "version": "3.0.0",
   "description": "Core integration for Barodoc documentation framework",
   "type": "module",
   "main": "./dist/index.js",