Appearance
object
Parses the content of a file to search for a @vitepress comment block and extracts the frontmatter data.
string
Parses the content of a file and constructs a structured markdown header based on the @vitepress comment block.
Kind: global functionReturns: object - - An object containing the extracted frontmatter data and attributes.Throws:
Error
Kind: global functionReturns: string - - A structured markdown header.
DirectoryFile
Parse Vitepress Comment
Functions
object
Parses the content of a file to search for a @vitepress comment block and extracts the frontmatter data.
string
Parses the content of a file and constructs a structured markdown header based on the @vitepress comment block.
parseComment(fileContent) ⇒
object
Parses the content of a file to search for a @vitepress comment block and extracts the frontmatter data.
Kind: global function
Returns:
object
- - An object containing the extracted frontmatter data and attributes.Throws:
Error
- Returns an object with null values if parsing fails.string
parseVitepressFileHeader(content, file) ⇒
string
Parses the content of a file and constructs a structured markdown header based on the @vitepress comment block.
Kind: global function
Returns:
string
- - A structured markdown header.string
DirectoryFile