Interface ITocGeneratorService

Namespace: Volo.Docs.TableOfContents

Assembly: Volo.Docs.Application.Contracts.dll

Syntax

public interface ITocGeneratorService : IApplicationService, IRemoteService

Methods

GenerateTocHeadings(string)

Declaration

List<TocHeading> GenerateTocHeadings(string markdownContent)

Parameters

Type	Name	Description
string	markdownContent

Returns

Type	Description
List<TocHeading>

GenerateTocItems(List<TocHeading>, int, int)

Declaration

List<TocItem> GenerateTocItems(List<TocHeading> tocHeadings, int topLevel, int levelCount)

Parameters

Type	Name	Description
List<TocHeading>	tocHeadings
int	topLevel
int	levelCount

Returns

Type	Description
List<TocItem>

GenerateTocItems(string, int, int?)

Declaration

List<TocItem> GenerateTocItems(string markdownContent, int levelCount, int? topLevel = null)

Parameters

Type	Name	Description
string	markdownContent
int	levelCount
int?	topLevel

Returns

Type	Description
List<TocItem>

GetTopLevel(List<TocHeading>)

Declaration

int GetTopLevel(List<TocHeading> tocHeadings)

Parameters

Type	Name	Description
List<TocHeading>	tocHeadings

Returns

Type	Description
int

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)