buildSsg(options: ResolvedOptions, root: string): Promise<SsgBuildResult>Builds all markdown files to static HTML.Builds all markdown files to static HTML.
export async function buildSsg(options: ResolvedOptions, root: string): Promise<SsgBuildResult>options
ResolvedOptions
root
string
Promise<SsgBuildResult>
canonicalPageUrl(context: BuildSsgContext, urlPath: string): string | undefinedAbsolute URL of a page, or undefined when ssg.siteUrl is not set. Built the sam…Absolute URL of a page, or undefined when ssg.siteUrl is not set.
Built the same way get_og_image_url builds the image URL next to it, so the canonical link and og:image always agree about where the page lives.
function canonicalPageUrl(context: BuildSsgContext, urlPath: string): string | undefinedcontext
BuildSsgContext
urlPath
string
string | undefined
collectMarkdownFiles(srcDir: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string[]>Collects all markdown files from the source directory.Collects all markdown files from the source directory.
export async function collectMarkdownFiles(srcDir: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string[]>srcDir
string
extensions
readonly string[]
optional · default: DEFAULTMARKDOWNEXTENSIONS
Promise<string[]>
const DEFAULT_HTML_TEMPLATE = "<!-- ox-content default HTML template is Rust-backed -->"Deprecated compatibility export for consumers that imported the former TypeScri…Deprecated compatibility export for consumers that imported the former TypeScript SSG template. HTML generation is Rust-backed now.
export const DEFAULT_HTML_TEMPLATE = "<!-- ox-content default HTML template is Rust-backed -->"extractTitle(content: string, frontmatter: Record<string, unknown>): stringExtracts title from content or frontmatter.Extracts title from content or frontmatter.
export function extractTitle(content: string, frontmatter: Record<string, unknown>): stringcontent
string
frontmatter
Record<string, unknown>
string
formatTitle(name: string): stringFormats a file/dir name as a title.Formats a file/dir name as a title.
export function formatTitle(name: string): stringname
string
string
generateBareHtmlPage(content: string, title: string): stringGenerates bare HTML page (no navigation, no styles).Generates bare HTML page (no navigation, no styles).
export function generateBareHtmlPage(content: string, title: string): stringcontent
string
title
string
string
generateBarePage(page: SsgBarePage): stringGenerates a bare HTML page carrying head metadata and injected markup. Bare mod…Generates a bare HTML page carrying head metadata and injected markup.
Bare mode leaves the shell to the consumer, but the metadata here is already computed for the themed page and cannot be recovered afterwards — the generated OG image in particular was only discoverable by guessing at the output directory. A page with none of it set renders exactly what bare mode emitted before, which keeps the no-JS size baseline honest.
export function generateBarePage(page: SsgBarePage): stringpage
SsgBarePage
string
generateHtmlPage(pageData: SsgPageData, navGroups: NavGroup[], siteName: string, base: string, ogImage?: string, theme?: ResolvedThemeConfig, locale?: string, availableLocales?: LocaleConfig[]): Promise<string>Generates HTML page with navigation using Rust NAPI bindings.Generates HTML page with navigation using Rust NAPI bindings.
export async function generateHtmlPage(pageData: SsgPageData, navGroups: NavGroup[], siteName: string, base: string, ogImage?: string, theme?: ResolvedThemeConfig, locale?: string, availableLocales?: LocaleConfig[]): Promise<string>pageData
SsgPageData
navGroups
NavGroup[]
siteName
string
base
string
ogImage
string
optional
theme
ResolvedThemeConfig
optional
locale
string
optional
availableLocales
LocaleConfig[]
optional
Promise<string>
getHref(inputPath: string, srcDir: string, base: string, extension: string): stringConverts a markdown file path to an href.Converts a markdown file path to an href.
export function getHref(inputPath: string, srcDir: string, base: string, extension: string): stringinputPath
string
srcDir
string
base
string
extension
string
string
getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string): stringConverts a markdown file path to its corresponding HTML output path.Converts a markdown file path to its corresponding HTML output path.
export function getOutputPath(inputPath: string, srcDir: string, outDir: string, extension: string): stringinputPath
string
srcDir
string
outDir
string
extension
string
string
getUrlPath(inputPath: string, srcDir: string): stringConverts a markdown file path to a relative URL path.Converts a markdown file path to a relative URL path.
export function getUrlPath(inputPath: string, srcDir: string): stringinputPath
string
srcDir
string
string
const localeCodesCache = new WeakMap<LocaleConfig[], string[]>()Per-build cache for the locale-code list passed to getSsgPageLocale. The i18n.l…Per-build cache for the locale-code list passed to getSsgPageLocale. The i18n.locales reference is stable across a build, so the .map to codes runs once instead of once per page.
const localeCodesCache = new WeakMap<LocaleConfig[], string[]>()resolveSsgOptions(ssg: SsgOptions | boolean | undefined): ResolvedSsgOptionsResolves SSG options with defaults.Resolves SSG options with defaults.
export function resolveSsgOptions(ssg: SsgOptions | boolean | undefined): ResolvedSsgOptionsssg
SsgOptions | boolean | undefined
RustLocaleRust-facing locale shape.Rust-facing locale shape.
interface RustLocale| Name | Type | Description |
|---|---|---|
code |
string |
|
dir |
string |
|
name |
string |
const rustLocalesCache = new WeakMap<LocaleConfig[], RustLocale[]>()Per-build cache for the Rust-facing locale list. i18n.locales is the same refer…Per-build cache for the Rust-facing locale list. i18n.locales is the same reference for every page in a build, so this mapping (and the ?? "ltr" default) only runs once per build instead of once per page.
const rustLocalesCache = new WeakMap<LocaleConfig[], RustLocale[]>()shouldGenerateOgImages(options: ResolvedOptions): booleanWhether this build emits one Open Graph image per page. ssg.bare deliberately d…Whether this build emits one Open Graph image per page.
ssg.bare deliberately does not turn this off. Bare mode only drops the generated page shell, and bringing your own shell is exactly the case where per-page OG images are still wanted — the images are written to the output tree and the consumer injects the <meta> tags itself. Nothing in the bare HTML references them, because bare output has no <head> to put them in.
export function shouldGenerateOgImages(options: ResolvedOptions): booleanoptions
ResolvedOptions
boolean
ssgSSG (Static Site Generation) module for ox-contentSSG (Static Site Generation) module for ox-content
SsgBarePageHead metadata and injected markup for a bare page.Head metadata and injected markup for a bare page.
export interface SsgBarePage| Name | Type | Description |
|---|---|---|
bodyEndoptional |
string |
|
bodyStartoptional |
string |
|
canonicalUrloptional |
string |
|
content |
string |
|
descriptionoptional |
string |
|
diroptional |
string |
|
headoptional |
string |
|
langoptional |
string |
|
ogImageoptional |
string |
|
siteNameoptional |
string |
|
title |
string |
SsgBuildResultResult of an SSG build.Result of an SSG build.
export interface SsgBuildResult| Name | Type | Description |
|---|---|---|
errors |
string[] |
Per-page failures that did not abort the build. |
files |
string[] |
Every file written, HTML pages and generated OG images alike. |
ogImages |
Record<string, string> |
Generated OG image URL per source file, keyed by absolute input path. Bare mode renders these into the page itself, but a consumer post-processing the output had no way to find them short of probing the output directory for og-image.png. |
SsgEntryPageConfigEntry page configuration for SSG (passed to Rust).Entry page configuration for SSG (passed to Rust).
export interface SsgEntryPageConfig| Name | Type | Description |
|---|---|---|
featuresoptional |
FeatureConfig[] |
|
herooptional |
HeroConfig |
SsgPageDataPage data for SSG.Page data for SSG.
export interface SsgPageData| Name | Type | Description |
|---|---|---|
content |
string |
|
descriptionoptional |
string |
|
entryPageoptional |
SsgEntryPageConfig |
Entry page configuration (if layout: entry) |
frontmatter |
Record<string, unknown> |
|
href |
string |
|
lastUpdatedoptional |
number |
|
path |
string |
|
title |
string |
|
toc |
TocEntry[] |
toRustTocEntry(entry: TocEntry): TocEntryConverts a TocEntry tree into the plain shape the Rust binding expects. Hoisted…Converts a TocEntry tree into the plain shape the Rust binding expects. Hoisted to module scope so it isn't reallocated for every page; the per-page .map over pageData.toc still runs since the TOC is page-specific.
function toRustTocEntry(entry: TocEntry): TocEntryentry
TocEntry
toThemePageData(pageResult: PageProcessResult): ThemePageDataMaps an internal page result onto the theme renderer's page shape.Maps an internal page result onto the theme renderer's page shape.
function toThemePageData(pageResult: PageProcessResult): ThemePageDatapageResult
PageProcessResult
ThemePageData