MarkdownlintAliases Class

Summary

Provides a wrapper around Markdownlint functionality within a Cake build script.
Assembly
Cake.Markdownlint.dll
Namespace
Cake.Markdownlint
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["MarkdownlintAliases"] class Type type-node

Syntax

public static class MarkdownlintAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
RunMarkdownlintNodeJs(ICakeContext, MarkdownlintNodeJsRunnerSettings) void
Runs Node.js markdownlint-cli with specified settings.
static
RunMarkdownlintNodeJsForDirectory(ICakeContext, DirectoryPath) void
Runs Node.js markdownlint-cli for a directory with default settings.
static
RunMarkdownlintNodeJsForSingleFile(ICakeContext, FilePath) void
Runs Node.js markdownlint-cli for a specific file with default settings.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin