RazorDocs Search

Models

Type

DocNode

Represents a documentation node within the repository.

Parameters

  • TitleThe display title of the document.
  • PathThe relative path to the documentation source.
  • ContentThe rendered HTML content of the documentation.
  • ParentPathThe optional parent path for hierarchical organization.
  • IsDirectoryIndicates if this node represents a directory container.
  • CanonicalPathThe browser-facing docs route path used for linking and lookup.
Type

IDocHarvester

Interface for harvesting documentation from various sources.

Method

HarvestAsync

Task<IEnumerable<DocNode>> HarvestAsync(string rootPath, CancellationToken cancellationToken = default)

Asynchronously scans the specified root path and returns a collection of documentation nodes harvested from sources under that path.

Parameters

  • rootPathThe filesystem root path to scan for documentation sources.
  • cancellationTokenAn optional token to observe for cancellation requests.

Returns

A collection of DocNode representing the harvested documentation.