Documentation
classes
typedoc-nextra
TypeDocNextra

TypeDocNextra

new TypeDocNextra(options)
ParameterTypeOptionalDescription
optionsTypeDocNextraMdBuilderOptions-

Properties

public linker: (t: string, s: string) => string

public options: TypeDocNextraMdBuilderOptions

Methods

public getClassHeading(c): string

ParameterTypeOptionalDescription
cDocumentedClass-

public getCtor(c): string

ParameterTypeOptionalDescription
cDocumentedClassConstructor-

public getMarkdown(c): string

ParameterTypeOptionalDescription
cDocumentedClass-

public getMethods(methods): string

ParameterTypeOptionalDescription
methodsArray<DocumentedClassMethod>-

public getProperties(properties): string

ParameterTypeOptionalDescription
propertiesArray<DocumentedClassProperty>-

public getTypeMarkdown(t): string

ParameterTypeOptionalDescription
tDocumentedTypes-

public transformClass(classes): Array<TypeDocNextraMarkdownBuild>

ParameterTypeOptionalDescription
classesArray<DocumentedClass>-

public transformTypes(types): Array<TypeDocNextraMarkdownBuild>

ParameterTypeOptionalDescription
typesArray<DocumentedTypes>-