MarkdownFileTopic.CreateContentReader Method

Namespace
Kampute.DocToolkit.Topics
Assembly
  • Kampute.DocToolkit.dll

Definition

Creates a TextReader to read the content of the source file, excluding any front matter.
protected override TextReader CreateContentReader(IDocumentationContext context)

Parameters

context IDocumentationContext
The documentation context that provides additional information for the operation.

Returns

TextReader
A TextReader for reading the content of the file specified by FileTopic.FilePath, starting after the front matter if present.

Exceptions

IOException
Thrown when an I/O error occurs while reading the file specified by FileTopic.FilePath.