IContentService

interface

Namespace: MyLittleContentEngine.Services.Content

A Content Service responsible for parsing and handling content.

Declaration

public interface IContentService

Methods

GetContentToCopyAsync

method

public abstract Task<ImmutableList<ContentToCopy>> GetContentToCopyAsync()

Gets the collection of content that should be copied to the output directory.

Returns: Task<ImmutableList<ContentToCopy>>

GetCrossReferencesAsync

method

public abstract Task<ImmutableList<CrossReference>> GetCrossReferencesAsync()

Gets the cross-references used in the content system, such as those found in the Table of Contents (ToC) or xref links.

Returns: Task<ImmutableList<CrossReference>>

GetPagesToGenerateAsync

method

public abstract Task<ImmutableList<PageToGenerate>> GetPagesToGenerateAsync()

Gets the collection of pages that should be generated for this content.

Returns: Task<ImmutableList<PageToGenerate>>

GetTocEntriesToGenerateAsync

method

public abstract Task<ImmutableList<PageToGenerate>> GetTocEntriesToGenerateAsync()

Gets the collection of pages that should appear in the Table of Contents. This is typically a subset of the pages returned by GetPagesToGenerateAsync(). For example, API documentation might generate thousands of pages but only want to show the root "/api/" entry in the TOC.

Returns: Task<ImmutableList<PageToGenerate>>