appendTaxonomyPages(input: { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; listedPages: readonly TaxonomySourcePage[]; options?: ResolvedTaxonomiesOptions; outDir: string; base: string; render: (page: TaxonomyGeneratedPage) => Promise<string>; errors: string[]; }): Promise<void>Renders themed list and per-term pages and appends them to the build.Renders themed list and per-term pages and appends them to the build.
export async function appendTaxonomyPages(input: {
generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>;
listedPages: readonly TaxonomySourcePage[];
options?: ResolvedTaxonomiesOptions;
outDir: string;
base: string;
render: (page: TaxonomyGeneratedPage) => Promise<string>;
errors: string[];
}): Promise<void>input
{ generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; listedPages: readonly TaxonomySourcePage[]; options?: ResolvedTaxonomiesOptions; outDir: string; base: string; render: (page: TaxonomyGeneratedPage) => Promise<string>; errors: string[] }
input.generatedPages
Array<{ inputPath: string; outputPath: string; html: string }>
input.listedPages
readonly TaxonomySourcePage[]
input.options?
ResolvedTaxonomiesOptions
optional
input.outDir
string
input.base
string
input.render
(page: TaxonomyGeneratedPage) => Promise<string>
input.errors
string[]
Promise<void>
resolveTaxonomiesOptions(value: boolean | TaxonomiesOptions | undefined): ResolvedTaxonomiesOptionsResolves taxonomies with defaults. false / omitted stays off. true enables tags…Resolves taxonomies with defaults.
false / omitted stays off. true enables tags and categories with relatedLimit 5. An object enables the feature and overrides only set fields.
export function resolveTaxonomiesOptions(value: boolean | TaxonomiesOptions | undefined): ResolvedTaxonomiesOptionsvalue
boolean | TaxonomiesOptions | undefined
taxonomiesOpt-in taxonomy term pages and related-page lists. Resolution and HTML live here. The Vite plugin injects related marku…Opt-in taxonomy term pages and related-page lists.
Resolution and HTML live here. The Vite plugin injects related markup into page content, then writes themed list and per-term pages during SSG.
TaxonomyGeneratedPageSynthetic page passed back to generateHtmlPage.Synthetic page passed back to generateHtmlPage.
export interface TaxonomyGeneratedPage| Name | Type | Description |
|---|---|---|
content |
string |
|
href |
string |
|
outputPath |
string |
|
title |
string |
|
urlPath |
string |
termSlug(term: string): string | undefinedStable URL slug for a frontmatter term. Returns undefined when the value cannot…Stable URL slug for a frontmatter term.
Returns undefined when the value cannot become a safe [a-z0-9-] href.
export function termSlug(term: string): string | undefinedterm
string
string | undefined
toTaxonomyProcessResult(page: TaxonomyGeneratedPage): { inputPath: string; routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string; }; transformedHtml: string; title: string; frontmatter: Record<string, unknown>; toc: []; }Maps a generated taxonomy page onto the SSG render shape.Maps a generated taxonomy page onto the SSG render shape.
export function toTaxonomyProcessResult(page: TaxonomyGeneratedPage): {
inputPath: string;
routePaths: {
outputPath: string;
urlPath: string;
href: string;
ogImagePath: string;
ogImageUrl: string;
};
transformedHtml: string;
title: string;
frontmatter: Record<string, unknown>;
toc: [];
}object
frontmatter: Record<string, unknown>;
inputPath: string;
routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string };
title: string;
toc: [];
transformedHtml: string;