DocumentMetadata

Defined in: packages/speculator/src/types/ast.generated.ts:498

Document-level metadata from frontmatter or config

Properties

abstract?

optional abstract: string

Defined in: packages/speculator/src/types/ast.generated.ts:530

---

authors?

optional authors: object[]

Defined in: packages/speculator/src/types/ast.generated.ts:515

company?

optional company: string

name?

optional name: string

note?

optional note: string

url?

optional url: string

w3cid?

optional w3cid: string

---

copyright?

optional copyright: string

Defined in: packages/speculator/src/types/ast.generated.ts:548

---

custom?

optional custom: object

Defined in: packages/speculator/src/types/ast.generated.ts:558

Highest priority user-defined properties

Index Signature

[k: string]: unknown

---

deps?

optional deps: string[]

Defined in: packages/speculator/src/types/ast.generated.ts:507

Dependencies from config.json

---

editors?

optional editors: object[]

Defined in: packages/speculator/src/types/ast.generated.ts:508

company?

optional company: string

name?

optional name: string

note?

optional note: string

url?

optional url: string

w3cid?

optional w3cid: string

---

group?

optional group: string | { name: string; url?: string; }

Defined in: packages/speculator/src/types/ast.generated.ts:542

---

lastUpdateDate?

optional lastUpdateDate: string

Defined in: packages/speculator/src/types/ast.generated.ts:529

Last update date (YYYY-MM-DD)

---

license?

optional license: string

Defined in: packages/speculator/src/types/ast.generated.ts:549

---

logos?

optional logos: object[]

Defined in: packages/speculator/src/types/ast.generated.ts:550

alt?

optional alt: string

href?

optional href: string

src

src: string

---

maturityLevel?

optional maturityLevel: "incubating" | "draft" | "prerelease" | "stable"

Defined in: packages/speculator/src/types/ast.generated.ts:534

Normalized maturity level

---

noConformance?

optional noConformance: boolean

Defined in: packages/speculator/src/types/ast.generated.ts:564

If true, disables automatic conformance section generation.

---

publishDate?

optional publishDate: string

Defined in: packages/speculator/src/types/ast.generated.ts:525

ISO 8601 date format (YYYY-MM-DD)

---

repository?

optional repository: string | { branch?: string; repoType?: "github" | "gitlab" | "manual"; url: string; }

Defined in: packages/speculator/src/types/ast.generated.ts:535

---

shortName?

optional shortName: string

Defined in: packages/speculator/src/types/ast.generated.ts:501

---

status?

optional status: string

Defined in: packages/speculator/src/types/ast.generated.ts:502

---

subtitle?

optional subtitle: string

Defined in: packages/speculator/src/types/ast.generated.ts:500

---

title?

optional title: string

Defined in: packages/speculator/src/types/ast.generated.ts:499

---

version?

optional version: string

Defined in: packages/speculator/src/types/ast.generated.ts:503