@takazudo/zudo-doc 1.3.0 → 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/chrome/derive.d.ts +68 -0
- package/dist/chrome/derive.js +231 -0
- package/dist/chrome/index.d.ts +37 -0
- package/dist/chrome/index.js +43 -0
- package/dist/doc-body-end/index.d.ts +9 -11
- package/dist/doc-body-end/index.js +4 -2
- package/dist/doc-content-header/index.d.ts +10 -2
- package/dist/doc-content-header/index.js +8 -8
- package/dist/doc-history-area/index.d.ts +10 -25
- package/dist/doc-history-area/index.js +14 -10
- package/dist/doc-metainfo-area/index.d.ts +9 -15
- package/dist/doc-metainfo-area/index.js +6 -2
- package/dist/doc-page-renderer/index.d.ts +11 -2
- package/dist/doc-page-renderer/index.js +22 -15
- package/dist/doc-page-shell/index.d.ts +11 -3
- package/dist/doc-page-shell/index.js +21 -14
- package/dist/doc-pager/index.d.ts +6 -7
- package/dist/doc-pager/index.js +2 -2
- package/dist/doc-route-entries/index.d.ts +22 -46
- package/dist/doc-route-entries/index.js +15 -10
- package/dist/doc-tags-area/index.d.ts +9 -19
- package/dist/doc-tags-area/index.js +12 -2
- package/dist/factory-context/index.d.ts +163 -1
- package/dist/footer-with-defaults/index.d.ts +12 -13
- package/dist/footer-with-defaults/index.js +8 -10
- package/dist/head-with-defaults/index.d.ts +12 -16
- package/dist/head-with-defaults/index.js +7 -9
- package/dist/header-with-defaults/index.d.ts +10 -31
- package/dist/header-with-defaults/index.js +15 -18
- package/dist/nav-source-docs/index.d.ts +20 -54
- package/dist/nav-source-docs/index.js +9 -10
- package/dist/route-context/index.d.ts +24 -0
- package/dist/route-context/index.js +147 -0
- package/dist/route-enumerators/index.d.ts +25 -74
- package/dist/route-enumerators/index.js +17 -18
- package/dist/routes/_chrome.d.ts +6 -25
- package/dist/routes/_chrome.js +14 -387
- package/dist/routes/_context.d.ts +10 -43
- package/dist/routes/_context.js +29 -157
- package/dist/sidebar-with-defaults/index.d.ts +8 -15
- package/dist/sidebar-with-defaults/index.js +6 -10
- package/dist/tag-pages/index.d.ts +12 -3
- package/dist/tag-pages/index.js +24 -19
- package/dist/versions-page/index.d.ts +10 -3
- package/dist/versions-page/index.js +18 -14
- package/eject/doc-pager/index.tsx +8 -10
- package/package.json +9 -1
- package/routes-src/_chrome.tsx +31 -552
- package/routes-src/_context.ts +37 -269
package/dist/routes/_chrome.js
CHANGED
|
@@ -1,393 +1,21 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
locales,
|
|
6
|
-
t,
|
|
7
|
-
withBase,
|
|
8
|
-
stripBase,
|
|
9
|
-
docsUrl,
|
|
10
|
-
versionedDocsUrl,
|
|
11
|
-
absoluteUrl,
|
|
12
|
-
navHref,
|
|
13
|
-
buildLocaleLinks,
|
|
14
|
-
getNavSectionForSlug,
|
|
15
|
-
getCategoryOrder,
|
|
16
|
-
toRouteSlug,
|
|
17
|
-
resolveNavSource,
|
|
18
|
-
loadNavSourceDocs,
|
|
19
|
-
buildNavTree,
|
|
20
|
-
groupSatelliteNodes,
|
|
21
|
-
collectAutoIndexNodes,
|
|
22
|
-
findNode,
|
|
23
|
-
firstRoutedHref,
|
|
24
|
-
collectTags,
|
|
25
|
-
stableDocs,
|
|
26
|
-
colorSchemes
|
|
27
|
-
} from "./_context.js";
|
|
28
|
-
import { createComposeMetaTitle } from "../compose-meta-title/index.js";
|
|
29
|
-
import {
|
|
30
|
-
generateCssCustomProperties,
|
|
31
|
-
generateLightDarkCssProperties
|
|
32
|
-
} from "../color-scheme-utils.js";
|
|
33
|
-
import { createHeadWithDefaults } from "../head-with-defaults/index.js";
|
|
34
|
-
import { createHeaderWithDefaults } from "../header-with-defaults/index.js";
|
|
35
|
-
import { createFooterWithDefaults } from "../footer-with-defaults/index.js";
|
|
36
|
-
import { createSidebarWithDefaults } from "../sidebar-with-defaults/index.js";
|
|
37
|
-
import { createSidebarPrepaint } from "../sidebar-prepaint/index.js";
|
|
38
|
-
import { createDocBodyEnd } from "../doc-body-end/index.js";
|
|
39
|
-
import { createBodyEndIslands } from "../doc-body-end-islands/index.js";
|
|
40
|
-
import { createDocPager } from "../doc-pager/index.js";
|
|
41
|
-
import { createDocPageShell } from "../doc-page-shell/index.js";
|
|
42
|
-
import { createDocContentHeader } from "../doc-content-header/index.js";
|
|
43
|
-
import { createDocMetainfoArea } from "../doc-metainfo-area/index.js";
|
|
44
|
-
import { createDocTagsArea } from "../doc-tags-area/index.js";
|
|
45
|
-
import { createDocHistoryArea } from "../doc-history-area/index.js";
|
|
46
|
-
import { createInlineVersionSwitcher } from "../inline-version-switcher/index.js";
|
|
47
|
-
import { createRenderDocPage } from "../doc-page-renderer/index.js";
|
|
48
|
-
import { createVersionsPageView } from "../versions-page/index.js";
|
|
49
|
-
import { createTagPages } from "../tag-pages/index.js";
|
|
50
|
-
import { createMdxComponents } from "../mdx-components/index.js";
|
|
51
|
-
import { createCategoryNavWrapper } from "../category-nav/index.js";
|
|
52
|
-
import { createCategoryTreeNavWrapper } from "../category-tree-nav/index.js";
|
|
53
|
-
import { createSiteTreeNavWrapper } from "../site-tree-nav/index.js";
|
|
54
|
-
import { getTocTitle } from "../toc/index.js";
|
|
55
|
-
import { SearchWidget } from "../search-widget/index.js";
|
|
56
|
-
import { buildGitHubRepoUrl, buildGitHubSourceUrl } from "../github-helpers/index.js";
|
|
57
|
-
import { toHistorySlug } from "../slug/index.js";
|
|
58
|
-
import {
|
|
59
|
-
buildRootMenuItems as buildRootMenuItemsBase,
|
|
60
|
-
buildLocaleLinksForNav as buildLocaleLinksForNavBase,
|
|
61
|
-
remapVersionedHrefs,
|
|
62
|
-
getThemeDefaultMode as getThemeDefaultModeBase
|
|
63
|
-
} from "../nav-data-prep/index.js";
|
|
64
|
-
import { buildSidebarForSection } from "../sidebar-utils/index.js";
|
|
65
|
-
import { Details } from "../details/index.js";
|
|
66
|
-
import {
|
|
67
|
-
HtmlPreviewWrapper
|
|
68
|
-
} from "../html-preview-wrapper/index.js";
|
|
69
|
-
const GREY_RAMP = [
|
|
70
|
-
"#000000",
|
|
71
|
-
"#1a1a1a",
|
|
72
|
-
"#333333",
|
|
73
|
-
"#4d4d4d",
|
|
74
|
-
"#666666",
|
|
75
|
-
"#808080",
|
|
76
|
-
"#999999",
|
|
77
|
-
"#b3b3b3",
|
|
78
|
-
"#cccccc",
|
|
79
|
-
"#d9d9d9",
|
|
80
|
-
"#e6e6e6",
|
|
81
|
-
"#f2f2f2",
|
|
82
|
-
"#ff5555",
|
|
83
|
-
"#50fa7b",
|
|
84
|
-
"#f1fa8c",
|
|
85
|
-
"#8be9fd"
|
|
86
|
-
];
|
|
87
|
-
const DEFAULT_SCHEME = {
|
|
88
|
-
background: "#000000",
|
|
89
|
-
foreground: "#ffffff",
|
|
90
|
-
cursor: "#ffffff",
|
|
91
|
-
selectionBg: "#444444",
|
|
92
|
-
selectionFg: "#ffffff",
|
|
93
|
-
palette: GREY_RAMP
|
|
94
|
-
};
|
|
95
|
-
const docHistoryMeta = {};
|
|
96
|
-
const sidebarsConfig = {};
|
|
97
|
-
const BodyEndIslands = createBodyEndIslands({ settings });
|
|
98
|
-
function DocHistoryStub(_props) {
|
|
99
|
-
return /* @__PURE__ */ jsx(Fragment, {});
|
|
100
|
-
}
|
|
101
|
-
function SearchWidgetBound(props) {
|
|
102
|
-
return SearchWidget({ ...props, base: withBase("/") });
|
|
103
|
-
}
|
|
104
|
-
const composeMetaTitle = createComposeMetaTitle(settings.siteName);
|
|
105
|
-
function resolveHostScheme(key) {
|
|
106
|
-
if (!colorSchemes) return DEFAULT_SCHEME;
|
|
107
|
-
return colorSchemes[key] ?? DEFAULT_SCHEME;
|
|
108
|
-
}
|
|
109
|
-
const HeadWithDefaults = createHeadWithDefaults({
|
|
110
|
-
settings,
|
|
111
|
-
composeMetaTitle,
|
|
112
|
-
withBase,
|
|
113
|
-
absoluteUrl,
|
|
114
|
-
// Called only in single-scheme mode (colorMode false): resolve via settings.colorScheme.
|
|
115
|
-
generateCssCustomProperties: () => generateCssCustomProperties(resolveHostScheme(settings.colorScheme)),
|
|
116
|
-
// Called only in light/dark mode (colorMode truthy): resolve the pair.
|
|
117
|
-
generateLightDarkCssProperties: () => {
|
|
118
|
-
const cm = settings.colorMode;
|
|
119
|
-
if (cm) {
|
|
120
|
-
return generateLightDarkCssProperties(
|
|
121
|
-
resolveHostScheme(cm.lightScheme),
|
|
122
|
-
resolveHostScheme(cm.darkScheme)
|
|
123
|
-
);
|
|
124
|
-
}
|
|
125
|
-
return generateLightDarkCssProperties(DEFAULT_SCHEME, DEFAULT_SCHEME);
|
|
126
|
-
}
|
|
127
|
-
});
|
|
128
|
-
function buildRootMenuItems(lang, currentVersion) {
|
|
129
|
-
return buildRootMenuItemsBase(
|
|
130
|
-
lang,
|
|
131
|
-
currentVersion,
|
|
132
|
-
settings.headerNav,
|
|
133
|
-
(key, l) => t(key, l),
|
|
134
|
-
(path, l, v) => navHref(path, l, v)
|
|
135
|
-
);
|
|
136
|
-
}
|
|
137
|
-
function buildLocaleLinksForNav(currentPath, lang, localeCount) {
|
|
138
|
-
return buildLocaleLinksForNavBase(
|
|
139
|
-
currentPath,
|
|
140
|
-
lang,
|
|
141
|
-
localeCount,
|
|
142
|
-
(path, l) => buildLocaleLinks(path, l)
|
|
143
|
-
);
|
|
144
|
-
}
|
|
145
|
-
function buildSidebarNodes(lang, navSection, currentVersion, emptyWhenUnsectioned = true) {
|
|
146
|
-
if (navSection === void 0 && emptyWhenUnsectioned) return [];
|
|
147
|
-
const { navDocs, categoryMeta } = loadNavSourceDocs(lang, currentVersion);
|
|
148
|
-
const explicitPrefixes = getCategoryOrder().filter((cm) => cm !== "!");
|
|
149
|
-
const rawNodes = buildSidebarForSection(
|
|
150
|
-
navDocs,
|
|
151
|
-
lang,
|
|
152
|
-
navSection,
|
|
153
|
-
categoryMeta,
|
|
154
|
-
sidebarsConfig,
|
|
155
|
-
(d, l, meta) => buildNavTree(
|
|
156
|
-
d,
|
|
157
|
-
l,
|
|
158
|
-
meta,
|
|
159
|
-
(slug, loc) => docsUrl(slug, loc)
|
|
160
|
-
),
|
|
161
|
-
explicitPrefixes
|
|
162
|
-
);
|
|
163
|
-
return currentVersion ? remapVersionedHrefs(
|
|
164
|
-
rawNodes,
|
|
165
|
-
currentVersion,
|
|
166
|
-
lang,
|
|
167
|
-
(slug, v, l) => versionedDocsUrl(slug, v, l)
|
|
168
|
-
) : rawNodes;
|
|
169
|
-
}
|
|
170
|
-
function getThemeDefaultMode() {
|
|
171
|
-
return getThemeDefaultModeBase(settings.colorMode);
|
|
172
|
-
}
|
|
173
|
-
const HeaderWithDefaults = createHeaderWithDefaults({
|
|
174
|
-
settings,
|
|
175
|
-
defaultLocale,
|
|
176
|
-
locales,
|
|
177
|
-
t,
|
|
178
|
-
withBase,
|
|
179
|
-
stripBase,
|
|
180
|
-
docsUrl,
|
|
181
|
-
navHref,
|
|
182
|
-
versionedDocsUrl,
|
|
183
|
-
buildLocaleLinksForNav,
|
|
184
|
-
buildRootMenuItems,
|
|
185
|
-
buildSidebarNodes,
|
|
186
|
-
getThemeDefaultMode,
|
|
187
|
-
buildGitHubRepoUrl: () => buildGitHubRepoUrl(settings.githubUrl),
|
|
188
|
-
SearchWidget: SearchWidgetBound
|
|
189
|
-
});
|
|
190
|
-
const FooterWithDefaults = createFooterWithDefaults({
|
|
191
|
-
settings,
|
|
192
|
-
defaultLocale,
|
|
193
|
-
tagVocabulary: [],
|
|
194
|
-
isExternal: (href) => /^https?:\/\//.test(href),
|
|
195
|
-
resolveHref: (href) => /^https?:\/\//.test(href) ? href : withBase(href),
|
|
196
|
-
withBase,
|
|
197
|
-
// The footer taglist is host-bound (project tag aggregation); package default
|
|
198
|
-
// renders no tag columns.
|
|
199
|
-
loadTagsForLocale: () => []
|
|
200
|
-
});
|
|
201
|
-
const SidebarWithDefaults = createSidebarWithDefaults({
|
|
202
|
-
defaultLocale,
|
|
203
|
-
localeCount: locales.length,
|
|
204
|
-
buildRootMenuItems,
|
|
205
|
-
buildLocaleLinksForNav,
|
|
206
|
-
buildSidebarNodes,
|
|
207
|
-
getThemeDefaultMode,
|
|
208
|
-
t
|
|
209
|
-
});
|
|
210
|
-
const SidebarPrepaint = createSidebarPrepaint({ sidebarToggle: settings.sidebarToggle });
|
|
211
|
-
const DocBodyEnd = createDocBodyEnd({ settings, BodyEndIslands });
|
|
212
|
-
const DocPager = createDocPager({ t });
|
|
213
|
-
const DocMetainfoArea = createDocMetainfoArea({
|
|
214
|
-
settings,
|
|
215
|
-
defaultLocale,
|
|
216
|
-
docHistoryMeta,
|
|
217
|
-
t,
|
|
218
|
-
toHistorySlug
|
|
219
|
-
});
|
|
220
|
-
const DocTagsArea = createDocTagsArea({
|
|
221
|
-
settings,
|
|
222
|
-
defaultLocale,
|
|
223
|
-
tagVocabularyEntries: [],
|
|
224
|
-
tagHref: (tag, locale) => {
|
|
225
|
-
const encoded = encodeURIComponent(tag);
|
|
226
|
-
return withBase(
|
|
227
|
-
locale === defaultLocale ? `/docs/tags/${encoded}` : `/${locale}/docs/tags/${encoded}`
|
|
228
|
-
);
|
|
229
|
-
},
|
|
230
|
-
t
|
|
231
|
-
});
|
|
232
|
-
const DocContentHeader = createDocContentHeader({
|
|
233
|
-
t,
|
|
234
|
-
buildFrontmatterPreviewEntries: () => [],
|
|
235
|
-
frontmatterRenderers: {},
|
|
236
|
-
DocMetainfoArea,
|
|
237
|
-
DocTagsArea
|
|
238
|
-
});
|
|
239
|
-
const DocHistoryArea = createDocHistoryArea({
|
|
240
|
-
settings,
|
|
241
|
-
defaultLocale,
|
|
242
|
-
docHistoryMeta,
|
|
243
|
-
t,
|
|
244
|
-
toHistorySlug,
|
|
245
|
-
buildGitHubSourceUrl: (contentDir, entryId) => buildGitHubSourceUrl(settings.githubUrl, contentDir, entryId),
|
|
246
|
-
DocHistory: DocHistoryStub
|
|
247
|
-
});
|
|
248
|
-
const buildInlineVersionSwitcher = createInlineVersionSwitcher({
|
|
249
|
-
settings,
|
|
250
|
-
defaultLocale,
|
|
251
|
-
t,
|
|
252
|
-
docsUrl,
|
|
253
|
-
versionedDocsUrl,
|
|
254
|
-
withBase
|
|
255
|
-
});
|
|
256
|
-
const CategoryNavWrapper = createCategoryNavWrapper({
|
|
257
|
-
defaultLocale,
|
|
258
|
-
resolveNavSource,
|
|
259
|
-
buildNavTree: ((docs, locale, categoryMeta) => buildNavTree(
|
|
260
|
-
docs,
|
|
261
|
-
locale,
|
|
262
|
-
categoryMeta,
|
|
263
|
-
(slug, loc) => docsUrl(slug, loc)
|
|
264
|
-
)),
|
|
265
|
-
findNode,
|
|
266
|
-
firstRoutedHref
|
|
267
|
-
});
|
|
268
|
-
const CategoryTreeNavWrapper = createCategoryTreeNavWrapper({
|
|
269
|
-
defaultLocale,
|
|
270
|
-
resolveNavSource,
|
|
271
|
-
buildNavTree: ((docs, locale, categoryMeta) => buildNavTree(
|
|
272
|
-
docs,
|
|
273
|
-
locale,
|
|
274
|
-
categoryMeta,
|
|
275
|
-
(slug, loc) => docsUrl(slug, loc)
|
|
276
|
-
)),
|
|
277
|
-
groupSatelliteNodes,
|
|
278
|
-
findNode
|
|
279
|
-
});
|
|
280
|
-
const SiteTreeNavWrapper = createSiteTreeNavWrapper({
|
|
281
|
-
defaultLocale,
|
|
282
|
-
resolveNavSource,
|
|
283
|
-
buildNavTree: ((docs, locale, categoryMeta) => buildNavTree(
|
|
284
|
-
docs,
|
|
285
|
-
locale,
|
|
286
|
-
categoryMeta,
|
|
287
|
-
(slug, loc) => docsUrl(slug, loc)
|
|
288
|
-
)),
|
|
289
|
-
groupSatelliteNodes,
|
|
290
|
-
getCategoryOrder
|
|
291
|
-
});
|
|
292
|
-
function HtmlPreviewBound(props) {
|
|
293
|
-
return HtmlPreviewWrapper({
|
|
294
|
-
globalConfig: settings.htmlPreview ?? null,
|
|
295
|
-
...props
|
|
296
|
-
});
|
|
297
|
-
}
|
|
298
|
-
function IslandPassthrough(props) {
|
|
299
|
-
return props.children ?? null;
|
|
300
|
-
}
|
|
301
|
-
function createMdxComponentsBound(lang = defaultLocale) {
|
|
302
|
-
return createMdxComponents({
|
|
303
|
-
settings,
|
|
304
|
-
locale: lang,
|
|
305
|
-
navData: {
|
|
306
|
-
CategoryNav: CategoryNavWrapper,
|
|
307
|
-
CategoryTreeNav: CategoryTreeNavWrapper,
|
|
308
|
-
SiteTreeNav: SiteTreeNavWrapper
|
|
309
|
-
},
|
|
310
|
-
// Package-owned content components wired here so an INJECTED docs route
|
|
311
|
-
// (packageOwnedRoutes, no host `pages/` stub) renders MDX using these tags
|
|
312
|
-
// without the "MDX requires '<X>' to be passed via the 'components' prop"
|
|
313
|
-
// error (sub-issue #2390 / supersedes #2377).
|
|
314
|
-
// - Details → fully functional (pure <details>, no client JS).
|
|
315
|
-
// - HtmlPreview → SSR-renders; see HtmlPreviewBound for the hydration
|
|
316
|
-
// caveat tied to the node_modules islands-scanner gap.
|
|
317
|
-
// - Island → SSR pass-through; see IslandPassthrough.
|
|
318
|
-
// PresetGenerator stays a package stub (render nothing): it is the
|
|
319
|
-
// showcase's project-bound interactive island and downstream projects stub
|
|
320
|
-
// it. The showcase keeps its host-owned docs catch-all routes (allowlisted)
|
|
321
|
-
// so its real PresetGenerator still renders.
|
|
322
|
-
extras: {
|
|
323
|
-
Details,
|
|
324
|
-
HtmlPreview: HtmlPreviewBound,
|
|
325
|
-
Island: IslandPassthrough,
|
|
326
|
-
PresetGenerator: (_props) => null
|
|
327
|
-
}
|
|
328
|
-
});
|
|
329
|
-
}
|
|
330
|
-
const DocPageShell = createDocPageShell({
|
|
331
|
-
settings,
|
|
1
|
+
import { routeCtx } from "./_context.js";
|
|
2
|
+
import { createChrome } from "../chrome/index.js";
|
|
3
|
+
const chrome = createChrome(routeCtx);
|
|
4
|
+
const {
|
|
332
5
|
composeMetaTitle,
|
|
333
|
-
getTocTitle,
|
|
334
6
|
HeadWithDefaults,
|
|
335
|
-
SidebarWithDefaults,
|
|
336
7
|
HeaderWithDefaults,
|
|
337
8
|
FooterWithDefaults,
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
createMdxComponents: createMdxComponentsBound,
|
|
349
|
-
t,
|
|
350
|
-
buildInlineVersionSwitcher,
|
|
351
|
-
DocPageShell,
|
|
352
|
-
DocContentHeader,
|
|
353
|
-
DocMetainfoArea,
|
|
354
|
-
DocHistoryArea
|
|
355
|
-
});
|
|
356
|
-
const VersionsPageView = createVersionsPageView({
|
|
357
|
-
settings,
|
|
358
|
-
defaultLocale,
|
|
359
|
-
t,
|
|
360
|
-
withBase,
|
|
361
|
-
composeMetaTitle,
|
|
362
|
-
components: {
|
|
363
|
-
HeadWithDefaults,
|
|
364
|
-
HeaderWithDefaults,
|
|
365
|
-
FooterWithDefaults,
|
|
366
|
-
BodyEndIslands
|
|
367
|
-
}
|
|
368
|
-
});
|
|
369
|
-
const tagPages = createTagPages({
|
|
370
|
-
settings,
|
|
371
|
-
defaultLocale,
|
|
372
|
-
t,
|
|
373
|
-
withBase,
|
|
374
|
-
docsUrl,
|
|
375
|
-
composeMetaTitle,
|
|
376
|
-
collectTags,
|
|
377
|
-
stableDocs,
|
|
378
|
-
isDefaultLocaleOnlyPath: void 0,
|
|
379
|
-
components: {
|
|
380
|
-
HeadWithDefaults,
|
|
381
|
-
HeaderWithDefaults,
|
|
382
|
-
FooterWithDefaults,
|
|
383
|
-
BodyEndIslands,
|
|
384
|
-
DocHistoryArea
|
|
385
|
-
}
|
|
386
|
-
});
|
|
387
|
-
const { collectTagMapForLocale, TagDetailPageView, TagsIndexPageView } = tagPages;
|
|
388
|
-
import {
|
|
389
|
-
buildDocRouteEntries
|
|
390
|
-
} from "./_context.js";
|
|
9
|
+
SidebarWithDefaults,
|
|
10
|
+
renderDocPage,
|
|
11
|
+
VersionsPageView,
|
|
12
|
+
collectTagMapForLocale,
|
|
13
|
+
TagDetailPageView,
|
|
14
|
+
TagsIndexPageView,
|
|
15
|
+
SiteTreeNavWrapper,
|
|
16
|
+
BodyEndIslands
|
|
17
|
+
} = chrome;
|
|
18
|
+
import { buildDocRouteEntries } from "./_context.js";
|
|
391
19
|
export {
|
|
392
20
|
BodyEndIslands,
|
|
393
21
|
FooterWithDefaults,
|
|
@@ -401,6 +29,5 @@ export {
|
|
|
401
29
|
buildDocRouteEntries,
|
|
402
30
|
collectTagMapForLocale,
|
|
403
31
|
composeMetaTitle,
|
|
404
|
-
createMdxComponentsBound,
|
|
405
32
|
renderDocPage
|
|
406
33
|
};
|
|
@@ -1,50 +1,19 @@
|
|
|
1
1
|
import type { Settings } from "../settings.js";
|
|
2
2
|
import type { ColorScheme } from "../color-scheme-utils.js";
|
|
3
|
-
import type
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
import { type TagVocabularyEntry } from "../tag-helpers/index.js";
|
|
7
|
-
import type { DocNavNode } from "../doc-page-props/index.js";
|
|
8
|
-
import type { HeadingItem } from "../extract-headings/index.js";
|
|
9
|
-
import { stableDocs, isNavVisible, buildNavTree, collectAutoIndexNodes, groupSatelliteNodes, findNode, firstRoutedHref } from "./_docs-helpers.js";
|
|
10
|
-
export interface RouteContextPayload {
|
|
11
|
-
settings: Settings;
|
|
12
|
-
translations: Record<string, Record<string, string>>;
|
|
13
|
-
tagVocabulary: readonly TagVocabularyEntry[];
|
|
14
|
-
colorSchemes: Record<string, ColorScheme> | null;
|
|
15
|
-
}
|
|
16
|
-
/** The serializable route-context (from the virtual module). */
|
|
3
|
+
import { type RouteContextPayload } from "../route-context/index.js";
|
|
4
|
+
export type { RouteContextPayload, TagInfo } from "../route-context/index.js";
|
|
5
|
+
/** The serializable route-context payload (from the virtual module). */
|
|
17
6
|
export declare const ctx: RouteContextPayload;
|
|
7
|
+
declare const routeCtx: import("../factory-context/index.js").RouteContext<Settings>;
|
|
8
|
+
export { routeCtx };
|
|
18
9
|
export declare const settings: Settings;
|
|
19
10
|
/** Host color-scheme palette map. `null` when not supplied — `_chrome.tsx`
|
|
20
11
|
* falls back to `DEFAULT_SCHEME` in that case. */
|
|
21
12
|
export declare const colorSchemes: Record<string, ColorScheme> | null;
|
|
22
|
-
export declare const defaultLocale: string
|
|
23
|
-
export declare const locales: readonly string[];
|
|
24
|
-
export declare function getLocaleConfig(locale: string): {
|
|
13
|
+
export declare const i18n: import("../factory-context/index.js").FactoryI18n, defaultLocale: string, locales: readonly string[], getLocaleConfig: (locale: string) => {
|
|
25
14
|
label: string;
|
|
26
15
|
dir: string;
|
|
27
|
-
} | undefined
|
|
28
|
-
export declare function getLocaleLabel(locale: string): string;
|
|
29
|
-
export declare function t(key: string, locale?: string): string;
|
|
30
|
-
export declare const i18n: FactoryI18n;
|
|
31
|
-
export declare const urlHelpers: UrlHelpers;
|
|
32
|
-
export declare const withBase: (path: string) => string, stripBase: (path: string) => string, docsUrl: (slug: string, lang?: string) => string, versionedDocsUrl: (slug: string, versionSlug: string, lang?: string) => string, navHref: (path: string, lang: string | undefined, currentVersion: string | undefined) => string, isDefaultLocaleOnlyPath: (path: string) => boolean, absoluteUrl: (pageUrl: string) => string | undefined, isExternal: (href: string) => boolean, resolveHref: (href: string) => string, buildLocaleLinks: (currentPath: string, currentLang: string) => import("../url-helpers/index.js").LocaleLink[];
|
|
33
|
-
export declare function getCategoryOrder(): string[];
|
|
34
|
-
export declare function getNavSectionForSlug(slug: string): string | undefined;
|
|
35
|
-
export declare function getNavSubtree(tree: DocNavNode[], categoryMatch?: string): DocNavNode[];
|
|
36
|
-
export declare function extractHeadings(body: string): HeadingItem[];
|
|
37
|
-
export interface TagInfo {
|
|
38
|
-
tag: string;
|
|
39
|
-
count: number;
|
|
40
|
-
docs: {
|
|
41
|
-
slug: string;
|
|
42
|
-
title: string;
|
|
43
|
-
description?: string;
|
|
44
|
-
}[];
|
|
45
|
-
}
|
|
46
|
-
export declare function resolveTagBound(raw: string): import("../tag-helpers/index.js").ResolvedTag;
|
|
47
|
-
export declare function collectTags(entries: ReadonlyArray<{
|
|
16
|
+
} | undefined, getLocaleLabel: (locale: string) => string, t: (key: string, locale?: string) => string, urlHelpers: import("../url-helpers/index.js").UrlHelpers, withBase: (path: string) => string, stripBase: (path: string) => string, docsUrl: (slug: string, lang?: string) => string, versionedDocsUrl: (slug: string, versionSlug: string, lang?: string) => string, navHref: (path: string, lang: string | undefined, currentVersion: string | undefined) => string, isDefaultLocaleOnlyPath: (path: string) => boolean, absoluteUrl: (pageUrl: string) => string | undefined, isExternal: (href: string) => boolean, resolveHref: (href: string) => string, buildLocaleLinks: (currentPath: string, currentLang: string) => import("../url-helpers/index.js").LocaleLink[], getCategoryOrder: () => string[], getNavSectionForSlug: (slug: string) => string | undefined, getNavSubtree: (tree: import("./_docs-helpers.js").DocNavNode[], categoryMatch?: string) => import("./_docs-helpers.js").DocNavNode[], extractHeadings: (body: string) => import("../extract-headings/index.js").HeadingItem[], resolveTagBound: (raw: string) => import("../tag-helpers/index.js").ResolvedTag, collectTags: (entries: ReadonlyArray<{
|
|
48
17
|
id: string;
|
|
49
18
|
data: {
|
|
50
19
|
slug?: string;
|
|
@@ -54,8 +23,6 @@ export declare function collectTags(entries: ReadonlyArray<{
|
|
|
54
23
|
};
|
|
55
24
|
}>, slugFn: (id: string, data: {
|
|
56
25
|
slug?: string;
|
|
57
|
-
}) => string): Map<string,
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
export declare const enumerateDocsRoutes: (locale: string) => string[], enumerateTagsRoutes: (locale: string) => string[], enumerateVersionedRoutes: (version: import("../route-enumerators/index.js").VersionConfigForEnum, locale: string) => string[], enumerateAllRoutes: () => Map<string, string>;
|
|
61
|
-
export { buildNavTree, groupSatelliteNodes, findNode, firstRoutedHref, collectAutoIndexNodes, isNavVisible, stableDocs, toRouteSlug, toSlugParams, };
|
|
26
|
+
}) => string) => Map<string, import("./_context.js").TagInfo>, resolveNavSource: (lang: string, currentVersion: string | undefined, options?: import("../nav-source-docs/index.js").NavSourceOptions) => import("../nav-source-docs/index.js").NavSourceDocs, resolveVersionedLocaleSource: (versionSlug: string, versionDocsDir: string | undefined, lang: string, localeDir: string | undefined, options?: import("../nav-source-docs/index.js").NavSourceOptions) => import("../nav-source-docs/index.js").NavSourceDocs, loadNavSourceDocs: (lang: string, currentVersion: string | undefined) => import("../nav-source-docs/index.js").NavSourceDocs, buildDocRouteEntries: (args: import("../doc-route-entries/index.js").BuildDocRouteEntriesArgs) => import("../doc-route-entries/index.js").DocRouteEntry[], enumerateDocsRoutes: (locale: string) => string[], enumerateTagsRoutes: (locale: string) => string[], enumerateVersionedRoutes: (version: import("../route-enumerators/index.js").VersionConfigForEnum, locale: string) => string[], enumerateAllRoutes: () => Map<string, string>, buildNavTree: (docs: import("./_docs-helpers.js").DocPageEntry[], locale: string, categoryMeta: Map<string, import("./_docs-helpers.js").CategoryMeta> | undefined, buildHref: import("../factory-context/index.js").RouteHrefBuilder, options?: {
|
|
27
|
+
buildHref?: import("../factory-context/index.js").RouteHrefBuilder;
|
|
28
|
+
}) => import("./_docs-helpers.js").DocNavNode[], groupSatelliteNodes: (tree: import("./_docs-helpers.js").DocNavNode[], prefixes: string[]) => import("./_docs-helpers.js").DocNavNode[], findNode: (nodes: import("./_docs-helpers.js").DocNavNode[], slug: string) => import("./_docs-helpers.js").DocNavNode | undefined, firstRoutedHref: (node: import("./_docs-helpers.js").DocNavNode) => string | undefined, collectAutoIndexNodes: (nodes: import("./_docs-helpers.js").DocNavNode[]) => import("./_docs-helpers.js").DocNavNode[], isNavVisible: (doc: import("./_docs-helpers.js").DocPageEntry) => boolean, stableDocs: (collectionName: string) => import("./_docs-helpers.js").DocPageEntry[], toRouteSlug: (id: string) => string, toSlugParams: (routeSlug: string) => string[];
|