Summary

Exported Class

API Reference

Exported Class

Article

Properties

title: string

summary: string?

sitePath: string?

lastUpdated: string?

meta: ArticleMeta?

hero: ArticleMeta?

body: string

sourceFilename: string

generatedSectionPages: { GeneratedSectionPage }?

Article.fromSource

Article.fromSource(source: string, sourceFilename: string) → Article

Article.fromFile

Article.fromFile(path: string) → Article

Article.generated

Article.generated(title: string, sourceFilename: string, body: string?, summary: string?, generatedSectionPages: { GeneratedSectionPage }?) → Article

Article:generateToc

Article:generateToc() → { markdown.TocEntry }

Types

ArticleMeta

type ArticleMeta = { [string]: any }

SidebarModule

name: string

displayName: string

filename: string

children: { SidebarModule }

SidebarArticle

title: string

filename: string

summary: string?

GeneratedSectionPage

title: string

article: any