section-index.ts#

6 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

6 symbols 3 functions 2 interfaces 1 modules 12 parameters 10 members 3 returns

Reference#

appendSectionIndexPages(input: { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; collectedPages: readonly SectionIndexSourcePage[]; listedPages: readonly SectionIndexSourcePage[]; options?: ResolvedSectionIndexOptions; outDir: string; base: string; extension: string; errors: string[]; render: (page: SectionIndexGeneratedPage) => Promise<string>; }): Promise<void>

Appends generated section indexes for directories that have no real index.10 paramsreturns Promise<void>

Appends generated section indexes for directories that have no real index.

Signature

export async function appendSectionIndexPages(input: {
  generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>;
  collectedPages: readonly SectionIndexSourcePage[];
  listedPages: readonly SectionIndexSourcePage[];
  options?: ResolvedSectionIndexOptions;
  outDir: string;
  base: string;
  extension: string;
  errors: string[];
  render: (page: SectionIndexGeneratedPage) => Promise<string>;
}): Promise<void>

View source

Parameters

input { generatedPages: Array<{ inputPath: string; outputPath: string; html: string }>; collectedPages: readonly SectionIndexSourcePage[]; listedPages: readonly SectionIndexSourcePage[]; options?: ResolvedSectionIndexOptions; outDir: string; base: string; extension: string; errors: string[]; render: (page: SectionIndexGeneratedPage) => Promise<string> }
input.generatedPages Array<{ inputPath: string; outputPath: string; html: string }>
input.collectedPages readonly SectionIndexSourcePage[]
input.listedPages readonly SectionIndexSourcePage[]
input.options? ResolvedSectionIndexOptions

optional
input.outDir string
input.base string
input.extension string
input.errors string[]
input.render (page: SectionIndexGeneratedPage) => Promise<string>

Returns

Promise<void>

fnresolveSectionIndexOptions(value: boolean | SectionIndexOptions | undefined): ResolvedSectionIndexOptionsResolves ssg.sectionIndex with defaults. false / omitted stays off. true enable…1 paramreturns ResolvedSectionIndexOptions

Resolves ssg.sectionIndex with defaults.

false / omitted stays off. true enables card listings. An object enables the feature and overrides only the fields the site set.

Signature

export function resolveSectionIndexOptions(value: boolean | SectionIndexOptions | undefined): ResolvedSectionIndexOptions

View source

Parameters

value boolean | SectionIndexOptions | undefined

Returns

ResolvedSectionIndexOptions

modulesection-indexOpt-in generated section index pages. Resolution and directory walking live here. Listing HTML is rendered in Rust (ox_…

Opt-in generated section index pages.

Resolution and directory walking live here. Listing HTML is rendered in Rust (ox_content_ssg::render_section_index) when the NAPI helper is available; a matching TypeScript renderer covers the same escape / href rules so the SSG path stays safe either way. The Vite plugin appends themed HTML during SSG and never overwrites an existing index page.

View source

interfaceSectionIndexGeneratedPageSynthetic page passed back to generateHtmlPage.5 members

Synthetic page passed back to generateHtmlPage.

Signature

export interface SectionIndexGeneratedPage

View source

Members

Properties

Name	Type	Description
`content`	`string`
`href`	`string`
`outputPath`	`string`
`title`	`string`
`urlPath`	`string`

interfaceSectionIndexSourcePageOne built page considered when deciding indexes and children.5 members

One built page considered when deciding indexes and children.

Signature

export interface SectionIndexSourcePage

View source

Members

Properties

Name	Type	Description
`description`optional	`string`
`frontmatter`	`Record<string, unknown>`
`inputPath`optional	`string`
`routePaths`	`{ href: string; urlPath: string; outputPath?: string }`
`title`	`string`

toSectionIndexProcessResult(page: SectionIndexGeneratedPage): { 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 section index onto the SSG render shape.1 paramreturns object

Maps a generated section index onto the SSG render shape.

Signature

export function toSectionIndexProcessResult(page: SectionIndexGeneratedPage): {
  inputPath: string;
  routePaths: {
    outputPath: string;
    urlPath: string;
    href: string;
    ogImagePath: string;
    ogImageUrl: string;
  };
  transformedHtml: string;
  title: string;
  frontmatter: Record<string, unknown>;
  toc: [];
}

View source

Parameters

page SectionIndexGeneratedPage

Returns

object

frontmatter

frontmatter: Record<string, unknown>;

inputPath

inputPath: string;

routePaths

routePaths: { outputPath: string; urlPath: string; href: string; ogImagePath: string; ogImageUrl: string };

title

title: string;

transformedHtml

transformedHtml: string;