Documentation Language: Swift

Method

loadIndexContent(from:)

Loads and parses the INDEX.md file if it exists.

func loadIndexContent(from packageDirectory: URL) -> IndexContent?

Parameters

packageDirectory

The root directory of the package.

Return Value

The parsed index content, or nil if no INDEX.md exists.

Discussion

If the file starts with an H1 heading, it is extracted as the page title and removed from the body content.