Skip to content
Speculator

SpecConfig

Defined in: preprocess/types.ts:156

Normalized spec configuration

Internal representation derived from ReSpec-like config files. All optional fields have sensible defaults applied.

Properties

Section titled “Properties”

abstract?

Section titled “abstract?”

optional abstract: string

Defined in: preprocess/types.ts:188

Abstract text (if not in document body)

authors?

Section titled “authors?”

optional authors: PersonEntry[]

Defined in: preprocess/types.ts:185

Author list

Section titled “copyright?”

optional copyright: string

Defined in: preprocess/types.ts:191

Copyright notice

editors?

Section titled “editors?”

optional editors: PersonEntry[]

Defined in: preprocess/types.ts:182

Editor list

latestVersion?

Section titled “latestVersion?”

optional latestVersion: string

Defined in: preprocess/types.ts:176

Latest version URL

license?

Section titled “license?”

optional license: string

Defined in: preprocess/types.ts:194

License URL

logos?

Section titled “logos?”

optional logos: object[]

Defined in: preprocess/types.ts:197

Additional logos

alt?

Section titled “alt?”

optional alt: string

href?

Section titled “href?”

optional href: string

src

Section titled “src”

src: string

maxTocLevel?

Section titled “maxTocLevel?”

optional maxTocLevel: number

Defined in: preprocess/types.ts:203

Maximum ToC depth

previousVersion?

Section titled “previousVersion?”

optional previousVersion: string

Defined in: preprocess/types.ts:179

Previous version URL

publishDate?

Section titled “publishDate?”

optional publishDate: string

Defined in: preprocess/types.ts:170

Publication date (ISO 8601: YYYY-MM-DD)

shortName?

Section titled “shortName?”

optional shortName: string

Defined in: preprocess/types.ts:161

Short name for URLs/references (e.g., “html”, “css-grid”)

specProfile?

Section titled “specProfile?”

optional specProfile: string

Defined in: preprocess/types.ts:206

Custom specification profile/variant

status?

Section titled “status?”

optional status: string

Defined in: preprocess/types.ts:167

Spec status (e.g., “ED”, “WD”, “CR”, “REC”, “NOTE”)

subtitle?

Section titled “subtitle?”

optional subtitle: string

Defined in: preprocess/types.ts:164

Subtitle or tagline

thisVersion?

Section titled “thisVersion?”

optional thisVersion: string

Defined in: preprocess/types.ts:173

This version URL

title?

Section titled “title?”

optional title: string

Defined in: preprocess/types.ts:158

Document title

tocEnabled?

Section titled “tocEnabled?”

optional tocEnabled: boolean

Defined in: preprocess/types.ts:200

Enable table of contents generation