References Class

Summary

This section is used to allow for clean markdown references so that the readme file isn't complete cluttered with image urls and links.
Assembly
Rocket.Surgery.Nuke.dll
Namespace
Rocket.Surgery.Nuke.Readme
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IMarkdownReferences"] click Interface0 "/api/Rocket.Surgery.Nuke.Readme/IMarkdownReferences" Type-.->Interface1["IReadmeSection"] click Interface1 "/api/Rocket.Surgery.Nuke.Readme/IReadmeSection" Type["References"] class Type type-node

Syntax

public class References : IMarkdownReferences, IReadmeSection

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Constructors

Name Summary
References()

Properties

Name Value Summary
ConfigKey string
The configuration key, if you expect to get configuration from the yaml block.
Name string
The name of the section

Methods

Name Value Summary
AddReference(string, string, string) string
Adds a reference with optional alt text
Process(IDictionary<string, object>, IMarkdownReferences, IRocketBoosterBuild) string
Returns the markdown that will produce the badge

Extension Methods

Name Value Summary
SetBackingValue<References, TV>(Expression<Func<References, TV>>, TV) T
Sets the backing value.
With<References, TKey, TField>(Dictionary<TKey, TField>, IDictionary<TKey, TField>) TBuilder
Adds the specified dictionary to the provided dictionary.