Class MarkdownTagValidationRule

Inheritance
Object
MarkdownTagValidationRule
Inherited Members
Namespace: Microsoft.DocAsCode.Plugins
Assembly: Microsoft.DocAsCode.Plugins.dll
Syntax
public class MarkdownTagValidationRule

Properties

| Improve this Doc View Source

Behavior

Define tag's behavior.

Declaration
[JsonProperty("behavior", Required = Required.Always)]
public TagValidationBehavior Behavior { get; set; }
Property Value
Type Description
TagValidationBehavior
| Improve this Doc View Source

CustomValidatorContractName

The contract name for custom validator ICustomMarkdownTagValidator.

Declaration
[JsonProperty("customValidatorContractName")]
public string CustomValidatorContractName { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

Disable

Whether to disable this rule by default.

Declaration
[JsonProperty("disable")]
public bool Disable { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

MessageFormatter

The message formatter for warning and error. '{0}' is name of tag, '{1}' is the full tag.

Declaration
[JsonProperty("messageFormatter", Required = Required.Always)]
public string MessageFormatter { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

OpeningTagOnly

Only validate opening tag.

Declaration
[JsonProperty("openingTagOnly")]
public bool OpeningTagOnly { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Relation

The relation for tags.

Declaration
[JsonProperty("relation")]
public TagRelation Relation { get; set; }
Property Value
Type Description
TagRelation
| Improve this Doc View Source

TagNames

The names of tag.

Declaration
[JsonProperty("tagNames", Required = Required.Always)]
public List<string> TagNames { get; set; }
Property Value
Type Description
List<String>

Extension Methods