ContentProviderModule

PackageFsLiveDocs.Core

ContentProvider

ContentProvider loads Markdown, parses page metadata, expands transclusions, resolves semantic references, validates links, and copies documentation assets.

Capture uses expandTransclusions to create canonical Markdown while preserving xref identifiers.

Rendering uses resolveSnippets to resolve remaining semantic references and format matched semantic code blocks.

Use scanDocsWithOptions when you already have a semantic artifact. Use scanDocs for current syntax-only or default behavior.

Summary

Name	Signature	Synopsis
exampleShortcodePattern	exampleShortcodePattern	Matches the shortcode that transcludes an XML example into a page.
transcludedExampleNames	transcludedExampleNames body	Names of the XML examples a page body transcludes.
outputPathFor	outputPathFor docsDir filePath	Maps a Markdown file to its stable output path relative to the docs root.
copyStaticFiles	copyStaticFiles docsDir outputDir	Copies consumer-owned non-Markdown files from the docs tree into the generated site.
defaultTitle	defaultTitle filePath	No description available.
pipeline	pipeline	The shared Markdig pipeline with advanced extensions enabled.
deserializer	deserializer	The YAML deserializer for frontmatter processing.
findIndexIteration	findIndexIteration start f arr	Helper to find the index of an element starting from a given position.
parseFrontMatter	parseFrontMatter content	Parses the YAML frontmatter from a raw Markdown string.
findMember	findMember id package	Searches for a member by ID or Name within a PackageModel.
findEntity	findEntity id package	No description available.
findExample	findExample id package	No description available.
expandTransclusions	expandTransclusions body sourceDir package	Expands source and XML-example transclusions while preserving semantic cross-references.
resolveSnippets	resolveSnippets body sourceDir package rootPath	Resolves transclusions and semantic links for a current render.
loadPage	loadPage filePath sourceDir package rootPath currentOutputPath allowedOutputs	Loads and processes a single Markdown page.
scanDocsWithOptions	scanDocsWithOptions docsDir sourceDir package rootPath semanticCode	Scans guides and semantically formats F# fences using the supplied assembly references.
scanDocs	scanDocs docsDir sourceDir package rootPath	Scans the docs directory and loads all guide pages.
applyApiDocsWithOptions	applyApiDocsWithOptions docsDir sourceDir package semanticCode	Applies long-form API documentation with semantic F# formatting.
applyApiDocs	applyApiDocs docsDir sourceDir package	Applies long-form documentation from docs/api/*.md to the package model.

exampleShortcodePattern

Member

Matches the shortcode that transcludes an XML example into a page.

Returns

string

transcludedExampleNames

transcludedExampleNames body

Member

Names of the XML examples a page body transcludes.

Parameters

Name	Type	Description
body	string

Returns

Set<string>

outputPathFor

outputPathFor docsDir filePath

Member

Maps a Markdown file to its stable output path relative to the docs root.

Parameters

Name	Type	Description
docsDir	string
filePath	string

Returns

string

copyStaticFiles

copyStaticFiles docsDir outputDir

Member

Copies consumer-owned non-Markdown files from the docs tree into the generated site.

Parameters

Name	Type	Description
docsDir	string
outputDir	string

Returns

unit

defaultTitle

defaultTitle filePath

Member

Parameters

Name	Type	Description
filePath	string

Returns

string

pipeline

Member

The shared Markdig pipeline with advanced extensions enabled.

Returns

MarkdownPipeline

deserializer

Member

The YAML deserializer for frontmatter processing.

Returns

IDeserializer

findIndexIteration

findIndexIteration start f arr

Member

Helper to find the index of an element starting from a given position.

Parameters

Name	Type	Description
start	int
f	'T -> bool
arr	'T[]

Returns

int option

parseFrontMatter

parseFrontMatter content

Member

Parses the YAML frontmatter from a raw Markdown string.

Parameters

Name	Type	Description
content	string

Returns

(ContentMetadata * string) option

findMember

findMember id package

Member

Searches for a member by ID or Name within a PackageModel.

Parameters

Name	Type	Description
id	string
package	PackageModel

Returns

MemberModel option

findEntity

findEntity id package

Member

Parameters

Name	Type	Description
id	string
package	PackageModel

Returns

EntityModel option

findExample

findExample id package

Member

Parameters

Name	Type	Description
id	string
package	PackageModel

Returns

ExampleModel option

expandTransclusions

expandTransclusions body sourceDir package

Member

Expands source and XML-example transclusions while preserving semantic cross-references.

Parameters

Name	Type	Description
body	string
sourceDir	string
package	PackageModel

Returns

string

resolveSnippets

resolveSnippets body sourceDir package rootPath

Member

Resolves transclusions and semantic links for a current render.

Parameters

Name	Type	Description
body	string
sourceDir	string
package	PackageModel
rootPath	string

Returns

string

loadPage

loadPage filePath sourceDir package rootPath currentOutputPath allowedOutputs

Member

Loads and processes a single Markdown page.

Parameters

Name	Type	Description
filePath	string	The markdown file to read.
sourceDir	string	The root directory used to resolve snippet shortcodes.
package	PackageModel	The extracted package model used for examples and xrefs.
rootPath	string	The relative root path used when generating links.
currentOutputPath	string	The output HTML path used for link validation.
allowedOutputs	Set<string>	The set of known output pages used to validate local links.

Returns

ContentPage

scanDocsWithOptions

scanDocsWithOptions docsDir sourceDir package rootPath semanticCode

Member

Scans guides and semantically formats F# fences using the supplied assembly references.

Parameters

Name	Type	Description
docsDir	string
sourceDir	string
package	PackageModel
rootPath	string
semanticCode	Options

Returns

ContentPage list

scanDocs

scanDocs docsDir sourceDir package rootPath

Member

Scans the docs directory and loads all guide pages.

Parameters

Name	Type	Description
docsDir	string	The docs root containing markdown pages.
sourceDir	string	The source root used for snippet resolution.
package	PackageModel	The extracted package model used for xrefs and examples.
rootPath	string	The relative root path used when rendering links.

Returns

ContentPage list

applyApiDocsWithOptions

applyApiDocsWithOptions docsDir sourceDir package semanticCode

Member

Applies long-form API documentation with semantic F# formatting.

Parameters

Name	Type	Description
docsDir	string
sourceDir	string
package	PackageModel
semanticCode	Options

Returns

PackageModel

applyApiDocs

applyApiDocs docsDir sourceDir package

Member

Applies long-form documentation from docs/api/*.md to the package model.

Parameters

Name	Type	Description
docsDir	string	The docs root that contains the api subdirectory.
sourceDir	string	The source root used for snippet resolution.
package	PackageModel	The current package model to enrich.

Returns

PackageModel

Examples

ResolveSnippetExample

> let package = { Version = "1.0"; Entities = []; Scenarios = []; Packages = [] };;
val package: PackageModel = { Version = "1.0"
  Entities = []
  Scenarios = []
  Packages = [] }

> ContentProvider.resolveSnippets "Hello" "." package "";;
val it: string = "Hello"

ContentProviderModule

ContentProvider

Summary

exampleShortcodePattern

Returns

transcludedExampleNames

Parameters

Returns

outputPathFor

Parameters

Returns

copyStaticFiles

Parameters

Returns

defaultTitle

Parameters

Returns

pipeline

Returns

deserializer

Returns

findIndexIteration

Parameters

Returns

parseFrontMatter

Parameters

Returns

findMember

Parameters

Returns

findEntity

Parameters

Returns

findExample

Parameters

Returns

expandTransclusions

Parameters

Returns

resolveSnippets

Parameters

Returns

loadPage

Parameters

Returns

scanDocsWithOptions

Parameters

Returns

scanDocs

Parameters

Returns

applyApiDocsWithOptions

Parameters

Returns

applyApiDocs

Parameters

Returns

Examples

ResolveSnippetExample

Overview

Docs

API Reference