TableOfContentsFactory class

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createMarkDown({required RenderContext renderContext, required String relativePath, required bool includeFileLink, required bool gitHubWiki}) → Future<String>
createRelativePath(File file) → String
filesInDirectory(Directory directory) → List<File>
findFiles(String path) → List<File>
returns a list of files in the given path. path is a relative project path to a template file (e.g.: doc/template/README.md.template) or a folder with template files (e.g.: doc/template/wiki)
findTitles({required String outputFileName, required String markdown, required bool removeMdExtension}) → List<TitleLink>
hasMdExtension(String outputFileName) → bool
isHomeMd(String outputFileName) → bool
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
parseAndRender(File file, RenderContext renderContext) → Future<String>
removeTextInsideCodeBlocks(String markdown) → String
Removes all text inside Markdown code blocks (...) from the input.
toListWithoutLevelGabs(List<TitleLink> titleLinks) → List<TitleLink>
Converts a list of TitleLinks to a new list without gaps in the levels. so that it is correctly rendered in Markdown.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

engine → DocumentationTemplateEngine
final