Summary

Exported Class

API Reference

Exported Class

Article

Implements: ArticleFields

Properties

title: string

summary: string?

sitePath: string?

sourceRoot: 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

type SidebarModule = { name: string, displayName: string, filename: string, children: { SidebarModule } }

name: string

displayName: string

filename: string

children: { SidebarModule }

SidebarArticle

type SidebarArticle = { title: string, filename: string, summary: string? }

title: string

filename: string

summary: string?

GeneratedSectionPage

type GeneratedSectionPage = { title: string, article: any }

title: string

article: any