Class MarkdownEntryUtility

Namespace

Songhay.Publications

Assembly

Songhay.Publications.dll

Shares routines for MarkdownEntry.

public static class MarkdownEntryUtility

Inheritance

object

MarkdownEntryUtility

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GenerateEntryFor11Ty(string, string)

Generates or overwrites a MarkdownEntry file at the specified entry root.

public static MarkdownEntry GenerateEntryFor11Ty(string entryRoot, string title)

Parameters

entryRoot string

The conventional directory of MarkdownEntry drafts.

title string

see WithNew11TyFrontMatter(MarkdownEntry?, string?, DateTime, string?, string?).

Returns

MarkdownEntry

GenerateEntryFor11Ty(string?, string?, DateTime, string?, string?)

Generates or overwrites a MarkdownEntry file at the specified entry root.

public static MarkdownEntry GenerateEntryFor11Ty(string? entryRoot, string? title, DateTime inceptDate, string? path, string? tag)

Parameters

entryRoot string

The conventional directory of MarkdownEntry drafts.

title string

see WithNew11TyFrontMatter(MarkdownEntry?, string?, DateTime, string?, string?).

inceptDate DateTime

see WithNew11TyFrontMatter(MarkdownEntry?, string?, DateTime, string?, string?).

path string

see WithNew11TyFrontMatter(MarkdownEntry?, string?, DateTime, string?, string?).

tag string

see WithNew11TyFrontMatter(MarkdownEntry?, string?, DateTime, string?, string?).

Returns

MarkdownEntry

PublishEntryFor11Ty(string, string, string)

Publishes a MarkdownEntry from the specified entry root to the specified presentation root for the eleventy pipeline.

public static string PublishEntryFor11Ty(string entryRoot, string presentationRoot, string fileName)

Parameters

entryRoot string

The conventional directory of MarkdownEntry drafts.

presentationRoot string

The presentation target directory for publication.

fileName string

The name of the MarkdownEntry file in the entry directory.

Returns

string

Returns the path of the published file.

PublishEntryFor11Ty(string, string, string, DateTime)

Publishes a MarkdownEntry from the specified entry root to the specified presentation root for the eleventy pipeline.

public static string PublishEntryFor11Ty(string entryRoot, string presentationRoot, string fileName, DateTime publicationDate)

Parameters

entryRoot string

The conventional directory of MarkdownEntry drafts.

presentationRoot string

The presentation target directory for publication.

fileName string

The name of the MarkdownEntry file in the entry directory.

publicationDate DateTime

The DateTime of publication.

Returns

string

Returns the path of the published file.

Remarks

When the publication date is one day later or more than the entry incept date new eleventy FrontMatter will be generated and the presentation file will be renamed accordingly.