MarkdownFileTopic Class
- Namespace
- Kampute.DocToolkit.Topics
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents a documentation topic that is stored in a Markdown file.
public class MarkdownFileTopic : FileTopic- Inheritance
- object
- TopicSource
- ConvertibleTopic
- FileTopic
- MarkdownFileTopic
Remarks
The MarkdownFileTopic class handles a Markdown file as a documentation topic source. It automatically extracts the title from Markdown headings and attempts to convert the content to the appropriate format of the documentation system.
Thread Safety
Public static members of the type are guaranteed to be thread-safe. However, public instance members are not thread-safe.
Constructors
| MarkdownFileTopic(string, string) | Initializes a new instance of the MarkdownFileTopic class. |
Properties
| ContentFormat | Gets the format of the content in the topic. |
| FrontMatter | Gets the collection of front matter metadata associated with the Markdown file topic. |
Methods
| CreateContentReader(IDocumentationContext) | Creates a TextReader to read the content of the source file, excluding any front matter. |
| GenerateTitle() | Extracts the title of the topic from the Markdown file. |