LinkGenerator.

GetLink(NormalizedPath, string, DirectoryPath, string, string[], string[], bool) Method

Summary

Generates a normalized link given a path and other conditions.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Util
Containing Type
LinkGenerator

Syntax

public static string GetLink(NormalizedPath path, string host, DirectoryPath root, string scheme, string[] hidePages, string[] hideExtensions, bool lowercase)

Parameters

Name Type Description
path NormalizedPath The path to get a link for.
host string The host for the link (or null to omit the host).
root DirectoryPath The root path for the link (or null for no root path).
scheme string The scheme for the link (or null for "http").
hidePages string[] An array of page names to hide (or null to not hide any pages).
hideExtensions string[] An array of file extensions to hide (or null to not hide extensions or an empty array to hide all file extensions).
lowercase bool Indicates that the link should be rendered in all lowercase.

Return Value

Type Description
string A generated link.
GitHub