@barodoc/core 1.0.1 → 2.0.0
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/{chunk-SX42YS3W.js → chunk-TOOKPXGT.js} +18 -0
- package/dist/config/index.d.ts +64 -1
- package/dist/config/index.js +1 -1
- package/dist/i18n/index.d.ts +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/plugins/index.d.ts +2 -2
- package/dist/{types-Be4n5fTN.d.ts → types-EzD7o05V.d.ts} +19 -0
- package/package.json +1 -1
|
@@ -36,6 +36,18 @@ var searchSchema = z.object({
|
|
|
36
36
|
enabled: z.boolean().optional()
|
|
37
37
|
}).optional();
|
|
38
38
|
var lineNumbersSchema = z.boolean().optional();
|
|
39
|
+
var editLinkSchema = z.object({
|
|
40
|
+
baseUrl: z.string()
|
|
41
|
+
}).optional();
|
|
42
|
+
var announcementSchema = z.object({
|
|
43
|
+
text: z.string(),
|
|
44
|
+
link: z.string().optional(),
|
|
45
|
+
dismissible: z.boolean().optional()
|
|
46
|
+
}).optional();
|
|
47
|
+
var feedbackSchema = z.object({
|
|
48
|
+
enabled: z.boolean(),
|
|
49
|
+
endpoint: z.string().optional()
|
|
50
|
+
}).optional();
|
|
39
51
|
var pluginConfigSchema = z.union([
|
|
40
52
|
z.string(),
|
|
41
53
|
z.tuple([z.string(), z.record(z.unknown())])
|
|
@@ -44,12 +56,18 @@ var barodocConfigSchema = z.object({
|
|
|
44
56
|
name: z.string(),
|
|
45
57
|
logo: z.string().optional(),
|
|
46
58
|
favicon: z.string().optional(),
|
|
59
|
+
site: z.string().optional(),
|
|
60
|
+
base: z.string().optional(),
|
|
47
61
|
theme: themeConfigSchema,
|
|
48
62
|
i18n: i18nConfigSchema,
|
|
49
63
|
navigation: z.array(navItemSchema),
|
|
50
64
|
topbar: topbarSchema,
|
|
51
65
|
search: searchSchema,
|
|
52
66
|
lineNumbers: lineNumbersSchema,
|
|
67
|
+
editLink: editLinkSchema,
|
|
68
|
+
lastUpdated: z.boolean().optional(),
|
|
69
|
+
announcement: announcementSchema,
|
|
70
|
+
feedback: feedbackSchema,
|
|
53
71
|
plugins: z.array(pluginConfigSchema).optional(),
|
|
54
72
|
customCss: z.array(z.string()).optional()
|
|
55
73
|
});
|
package/dist/config/index.d.ts
CHANGED
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { R as ResolvedBarodocConfig, a as BarodocConfig } from '../types-
|
|
2
|
+
import { R as ResolvedBarodocConfig, a as BarodocConfig } from '../types-EzD7o05V.js';
|
|
3
3
|
import 'astro';
|
|
4
4
|
|
|
5
5
|
declare const barodocConfigSchema: z.ZodObject<{
|
|
6
6
|
name: z.ZodString;
|
|
7
7
|
logo: z.ZodOptional<z.ZodString>;
|
|
8
8
|
favicon: z.ZodOptional<z.ZodString>;
|
|
9
|
+
site: z.ZodOptional<z.ZodString>;
|
|
10
|
+
base: z.ZodOptional<z.ZodString>;
|
|
9
11
|
theme: z.ZodOptional<z.ZodObject<{
|
|
10
12
|
colors: z.ZodOptional<z.ZodObject<{
|
|
11
13
|
primary: z.ZodOptional<z.ZodString>;
|
|
@@ -123,6 +125,37 @@ declare const barodocConfigSchema: z.ZodObject<{
|
|
|
123
125
|
enabled?: boolean | undefined;
|
|
124
126
|
}>>;
|
|
125
127
|
lineNumbers: z.ZodOptional<z.ZodBoolean>;
|
|
128
|
+
editLink: z.ZodOptional<z.ZodObject<{
|
|
129
|
+
baseUrl: z.ZodString;
|
|
130
|
+
}, "strip", z.ZodTypeAny, {
|
|
131
|
+
baseUrl: string;
|
|
132
|
+
}, {
|
|
133
|
+
baseUrl: string;
|
|
134
|
+
}>>;
|
|
135
|
+
lastUpdated: z.ZodOptional<z.ZodBoolean>;
|
|
136
|
+
announcement: z.ZodOptional<z.ZodObject<{
|
|
137
|
+
text: z.ZodString;
|
|
138
|
+
link: z.ZodOptional<z.ZodString>;
|
|
139
|
+
dismissible: z.ZodOptional<z.ZodBoolean>;
|
|
140
|
+
}, "strip", z.ZodTypeAny, {
|
|
141
|
+
text: string;
|
|
142
|
+
link?: string | undefined;
|
|
143
|
+
dismissible?: boolean | undefined;
|
|
144
|
+
}, {
|
|
145
|
+
text: string;
|
|
146
|
+
link?: string | undefined;
|
|
147
|
+
dismissible?: boolean | undefined;
|
|
148
|
+
}>>;
|
|
149
|
+
feedback: z.ZodOptional<z.ZodObject<{
|
|
150
|
+
enabled: z.ZodBoolean;
|
|
151
|
+
endpoint: z.ZodOptional<z.ZodString>;
|
|
152
|
+
}, "strip", z.ZodTypeAny, {
|
|
153
|
+
enabled: boolean;
|
|
154
|
+
endpoint?: string | undefined;
|
|
155
|
+
}, {
|
|
156
|
+
enabled: boolean;
|
|
157
|
+
endpoint?: string | undefined;
|
|
158
|
+
}>>;
|
|
126
159
|
plugins: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>], null>]>, "many">>;
|
|
127
160
|
customCss: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
128
161
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -133,6 +166,8 @@ declare const barodocConfigSchema: z.ZodObject<{
|
|
|
133
166
|
}, z.ZodTypeAny, "passthrough">[];
|
|
134
167
|
logo?: string | undefined;
|
|
135
168
|
favicon?: string | undefined;
|
|
169
|
+
site?: string | undefined;
|
|
170
|
+
base?: string | undefined;
|
|
136
171
|
theme?: {
|
|
137
172
|
colors?: {
|
|
138
173
|
primary?: string | undefined;
|
|
@@ -164,6 +199,19 @@ declare const barodocConfigSchema: z.ZodObject<{
|
|
|
164
199
|
enabled?: boolean | undefined;
|
|
165
200
|
} | undefined;
|
|
166
201
|
lineNumbers?: boolean | undefined;
|
|
202
|
+
editLink?: {
|
|
203
|
+
baseUrl: string;
|
|
204
|
+
} | undefined;
|
|
205
|
+
lastUpdated?: boolean | undefined;
|
|
206
|
+
announcement?: {
|
|
207
|
+
text: string;
|
|
208
|
+
link?: string | undefined;
|
|
209
|
+
dismissible?: boolean | undefined;
|
|
210
|
+
} | undefined;
|
|
211
|
+
feedback?: {
|
|
212
|
+
enabled: boolean;
|
|
213
|
+
endpoint?: string | undefined;
|
|
214
|
+
} | undefined;
|
|
167
215
|
plugins?: (string | [string, Record<string, unknown>])[] | undefined;
|
|
168
216
|
customCss?: string[] | undefined;
|
|
169
217
|
}, {
|
|
@@ -174,6 +222,8 @@ declare const barodocConfigSchema: z.ZodObject<{
|
|
|
174
222
|
}, z.ZodTypeAny, "passthrough">[];
|
|
175
223
|
logo?: string | undefined;
|
|
176
224
|
favicon?: string | undefined;
|
|
225
|
+
site?: string | undefined;
|
|
226
|
+
base?: string | undefined;
|
|
177
227
|
theme?: {
|
|
178
228
|
colors?: {
|
|
179
229
|
primary?: string | undefined;
|
|
@@ -205,6 +255,19 @@ declare const barodocConfigSchema: z.ZodObject<{
|
|
|
205
255
|
enabled?: boolean | undefined;
|
|
206
256
|
} | undefined;
|
|
207
257
|
lineNumbers?: boolean | undefined;
|
|
258
|
+
editLink?: {
|
|
259
|
+
baseUrl: string;
|
|
260
|
+
} | undefined;
|
|
261
|
+
lastUpdated?: boolean | undefined;
|
|
262
|
+
announcement?: {
|
|
263
|
+
text: string;
|
|
264
|
+
link?: string | undefined;
|
|
265
|
+
dismissible?: boolean | undefined;
|
|
266
|
+
} | undefined;
|
|
267
|
+
feedback?: {
|
|
268
|
+
enabled: boolean;
|
|
269
|
+
endpoint?: string | undefined;
|
|
270
|
+
} | undefined;
|
|
208
271
|
plugins?: (string | [string, Record<string, unknown>])[] | undefined;
|
|
209
272
|
customCss?: string[] | undefined;
|
|
210
273
|
}>;
|
package/dist/config/index.js
CHANGED
package/dist/i18n/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { b as BarodocI18nConfig, c as BarodocNavItem } from '../types-
|
|
1
|
+
import { b as BarodocI18nConfig, c as BarodocNavItem } from '../types-EzD7o05V.js';
|
|
2
2
|
import 'astro';
|
|
3
3
|
|
|
4
4
|
declare function getLocaleFromPath(path: string, i18n: BarodocI18nConfig): string;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AstroIntegration } from 'astro';
|
|
2
|
-
import { B as BarodocOptions } from './types-
|
|
3
|
-
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-
|
|
2
|
+
import { B as BarodocOptions } from './types-EzD7o05V.js';
|
|
3
|
+
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';
|
|
4
4
|
export { barodocConfigSchema, loadConfig } from './config/index.js';
|
|
5
5
|
export { getLocaleFromPath, getLocaleLabel, getLocalizedNavGroup, getLocalizedPath, removeLocaleFromPath } from './i18n/index.js';
|
|
6
6
|
export { definePlugin, getPluginIntegrations, loadPlugins, runConfigHook, runHook } from './plugins/index.js';
|
package/dist/index.js
CHANGED
package/dist/plugins/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { k as ResolvedPlugin, j as PluginContext, P as PluginConfig, R as ResolvedBarodocConfig, f as BarodocPluginHooks, d as BarodocPlugin } from '../types-
|
|
2
|
-
export { e as BarodocPluginFactory, i as BuildContext, C as ContentContext } from '../types-
|
|
1
|
+
import { k as ResolvedPlugin, j as PluginContext, P as PluginConfig, R as ResolvedBarodocConfig, f as BarodocPluginHooks, d as BarodocPlugin } from '../types-EzD7o05V.js';
|
|
2
|
+
export { e as BarodocPluginFactory, i as BuildContext, C as ContentContext } from '../types-EzD7o05V.js';
|
|
3
3
|
import * as astro from 'astro';
|
|
4
4
|
|
|
5
5
|
/**
|
|
@@ -117,6 +117,8 @@ interface BarodocConfig {
|
|
|
117
117
|
name: string;
|
|
118
118
|
logo?: string;
|
|
119
119
|
favicon?: string;
|
|
120
|
+
site?: string;
|
|
121
|
+
base?: string;
|
|
120
122
|
theme?: BarodocThemeConfig;
|
|
121
123
|
i18n?: BarodocI18nConfig;
|
|
122
124
|
navigation: BarodocNavItem[];
|
|
@@ -130,6 +132,23 @@ interface BarodocConfig {
|
|
|
130
132
|
};
|
|
131
133
|
/** When true, code blocks render with line numbers. */
|
|
132
134
|
lineNumbers?: boolean;
|
|
135
|
+
/** GitHub edit link base URL for "Edit this page" links. */
|
|
136
|
+
editLink?: {
|
|
137
|
+
baseUrl: string;
|
|
138
|
+
};
|
|
139
|
+
/** When true, shows git-based last updated timestamp on each page. */
|
|
140
|
+
lastUpdated?: boolean;
|
|
141
|
+
/** Top-of-page announcement banner. */
|
|
142
|
+
announcement?: {
|
|
143
|
+
text: string;
|
|
144
|
+
link?: string;
|
|
145
|
+
dismissible?: boolean;
|
|
146
|
+
};
|
|
147
|
+
/** Page feedback widget ("Was this helpful?"). */
|
|
148
|
+
feedback?: {
|
|
149
|
+
enabled: boolean;
|
|
150
|
+
endpoint?: string;
|
|
151
|
+
};
|
|
133
152
|
plugins?: PluginConfig[];
|
|
134
153
|
customCss?: string[];
|
|
135
154
|
}
|