Action & Filters

getConfig

type	filter
param	config object
return	config object

Fires after the user config is merged with the defaults.

getPlugins

type	filter
param	plugins Plugin[]
return	Plugin[]

Fires after the active plugin list is resolved from config.

getNavigationBar

type	filter
param	content string
return	string

Fires after the navbar file is loaded, before it is used.

getHeaderFilePath

type	filter
param	filePath string
return	string

Fires for each discovered header file before it enters the file list.

extractMembersBefore

type	action
param	filePath string

Fires before ctags extracts members from a header file.

extractMembersAfter

type	action
param	result object[]

Fires after ctags extraction, before the result is returned.

extractedMembers

type	filter
param	result object[]
return	object[]

Fires after member extraction. Each item: { name, type, brief, line }.

parseHeaderFileBefore

type	action
param	filePath string

Fires before a header file is read and parsed.

getHeaderFileContent

type	filter
param	content string
return	string

Fires after the header file is read, before it is parsed.

getEnums

type	filter
param	entries object, name string
return	object

Fires after an enum is parsed, before it is stored. Each entry: { key, value, brief }.

getDTO

type	filter
param	entries object, name string
return	object

Fires after a struct is parsed, before it is stored. Each entry: { type, symbol, brief }.

getClassName

type	filter
param	className string
return	string

getClassBrief

type	filter
param	brief string
return	string

getClassMethods

type	filter
param	methods object[]
return	object[]

Each item: { name, brief, params, line }.

getClassParents

type	filter
param	parent string
return	string

getClassFileName

type	filter
param	fileName string
return	string

getClassMembers

type	filter
param	members object[]
return	object[]

Each item: { name, type, brief, line }.

parseClassesAfter

type	action
param	classes object[], instance MDExtract

Fires after all header files are parsed and this.classes is fully populated.

getClassMarkdown

type	filter
param	content string, cls object, instance MDExtract
return	string

Fires after a class markdown is generated, before it is written. Cross-links are already injected at this point.

getClassMarkdownPath

type	filter
param	filePath string
return	string

Fires before a class markdown file is written. Use to remap the output path.

getStructMarkdown

type	filter
param	content string
return	string

Fires after structs.md is generated, before it is written.

getEnumMarkdown

type	filter
param	content string
return	string

Fires after enums.md is generated, before it is written.

getNavbarMarkdown

type	filter
param	content string
return	string

Fires after navbar.md is generated, before it is written.

buildHTMLBefore

type	action
param	—

Fires before the HTML output folder is created and pages are rendered.

getPageName

type	filter
param	name string
return	string

Fires for each entry in the page list before rendering begins. Use to rename or skip pages.

buildPageBefore

type	action
param	pageName string

Fires before a single page starts rendering.

getNavbarHTML

type	filter
param	html string
return	string

Fires after the navbar markdown is converted to HTML by pandoc.

getPageTitle

type	filter
param	title string
return	string

Fires before the page title is injected into the layout.

customCss

type	filter
param	css string, pageName string, md MDExtract
return	string

Fires after the custom CSS file is loaded, before it is wrapped in a style tag.

getInlineScript

type	filter
param	js string
return	string

Fires after the inline JS file is loaded, before it is wrapped in a script tag.

getPageHTML

type	filter
param	html string
return	string

Fires after the page markdown is converted to HTML by pandoc.

getPageKeywords

type	filter
param	keywords string
return	string

Fires before the keyword string is injected into the meta template.

getPageMetaHTML

type	filter
param	html string
return	string

Fires after the meta template file is loaded, before %PLACEHOLDER% substitution.

getPageLayout

type	filter
param	html string
return	string

Fires after the layout template file is loaded, before %PLACEHOLDER% substitution.

buildSitemapBefore

type	action
param	—

Fires before the sitemap update loop begins.

getSitemapDate

type	filter
param	date string
return	string

Fires before the date is written into each sitemap entry. Format: YYYY-MM-DD.

getSitemapFrequency

type	filter
param	frequency string
return	string

Default value: monthly.

getSitemapPriority

type	filter
param	priority string
return	string

Default value: 0.9.

getSitemapEntry

type	filter
param	entry string
return	string

Fires after a <url> block is assembled, before it is pushed to the entries list.

getSitemapContent

type	filter
param	content string
return	string

Fires after all entries are injected into the sitemap XML, before the file is saved.

buildSitemapAfter

type	action
param	—

Fires after sitemap.xml has been saved.