ssg-output.ts#

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

5 symbols 1 functions 3 interfaces 1 modules 1 parameters 21 members 1 returns

Reference#

fnplanSsgOutputs(input: PlanSsgOutputsInput): SsgOutputPlanPlan resource, companion, feed, and sitemap outputs without rendering pages. ss…1 paramreturns SsgOutputPlan

Plan resource, companion, feed, and sitemap outputs without rendering pages.

ssg.enabled is ignored. Use ssg: { enabled: false, markdownSource, lastUpdated, siteUrl } so those fields still resolve. lastUpdated on a page wins over git.

Signature

export function planSsgOutputs(input: PlanSsgOutputsInput): SsgOutputPlan

View source

Parameters

input PlanSsgOutputsInput

Returns

SsgOutputPlan

interfacePlanSsgOutputsInputInputs for planning composable SSG outputs from host-rendered pages.9 members

Inputs for planning composable SSG outputs from host-rendered pages.

Signature

export interface PlanSsgOutputsInput

View source

Members

Properties

Name	Type	Description
`collectionNames`optional	`readonly string[]`
`collections`optional	`Record<string, readonly FeedItemInput[]>`
`items`optional	`readonly FeedItemInput[]`
`options`optional	`PlanSsgOutputsOptions \| Pick<OxContentOptions, keyof PlanSsgOutputsOptions>`
`outDir`	`string`
`pages`	`readonly SsgOutputPageInput[]`
`root`optional	`string`
`siteDescription`optional	`string`
`srcDir`optional	`string`

interfacePlanSsgOutputsOptionsSame option objects oxContent() / buildSsg() accept. ssg.enabled is ignored.7 members

Same option objects oxContent() / buildSsg() accept. ssg.enabled is ignored.

Signature

export interface PlanSsgOutputsOptions

View source

Members

Properties

Name	Type	Description
`base`optional	`string`
`feeds`optional	`boolean \| FeedsOptions`
`icons`optional	`boolean \| IconsOptions`
`publishState`optional	`boolean \| PublishStateOptions`
`resources`optional	`boolean \| ResourcesOptions`
`siteMaps`optional	`boolean \| SiteMapsOptions`
`ssg`optional	`boolean \| SsgOptions`

modulessg-outputComposable SSG outputs for custom hosts that set ssg: false. Ox Content owns resource fingerprinting, Markdown companio…

Composable SSG outputs for custom hosts that set ssg: false.

Ox Content owns resource fingerprinting, Markdown companions, feeds, sitemaps, and git lastmod. The host keeps page templates and HTML.

View source

interfaceSsgOutputPlanPlanned writer inputs. Call the matching write* function for each feature.5 members

Planned writer inputs. Call the matching write* function for each feature.

Signature

export interface SsgOutputPlan

View source

Members

Properties

Name	Type	Description
`feeds`	`{ outDir: string; base: string; siteUrl?: string; siteName?: string; siteDescription?: string; options: ResolvedFeedsOptions; publishState: ResolvedPublishStateOptions; collections?: Record<string, readonly FeedItemInput[]>; collectionNames?: readonly string[]; items?: readonly FeedItemInput[] }`
`markdownCompanions`	`{ outDir: string; base: string; options: ResolvedMarkdownSourceOptions; publishState: ResolvedPublishStateOptions; pages: MarkdownSourcePageInput[] }`
`resources`	`WriteResourceFilesInput`
`selfHostedAssets`	`WriteSelfHostedAssetsInput`
`siteMaps`	`{ outDir: string; base: string; siteUrl?: string; siteName?: string; siteDescription?: string; options: ResolvedSiteMapsOptions; pages: SiteMapPageInput[] }`