Class

MarkdownBadgeBuilder

OfficeIMO.Markdown

Edit on GitHub

Namespace: OfficeIMO.Markdown
Assembly: OfficeIMO.Markdown
Source revision: e163ccb36643 with working tree changes
Source: BadgeBuilder.cs:11
Modifiers: sealed

Helper to add common badges to README.

Inheritance

object
MarkdownBadgeBuilder

Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 6

Method MarkdownBadgeBuilder.Build
Method MarkdownBadgeBuilder.BuildForGitHub
Method MarkdownBadgeBuilder.Coverage
Method MarkdownBadgeBuilder.CoverageCodecov
Method MarkdownBadgeBuilder.Custom
Method MarkdownBadgeBuilder.NuGet

Accepted by parameters 1

Method MarkdownReadmeOptions.Badges parameter build

Methods

public MarkdownBadgeBuilder Build(string url) #

BadgeBuilder.cs:21

Adds a CI build badge link (explicit URL only, no dynamic image).

Parameters

url string required

Returns

MarkdownBadgeBuilder

public MarkdownBadgeBuilder BuildForGitHub(string owner, string repo, string? workflow = null, string? branch = null) #

BadgeBuilder.cs:24

Convenience for GitHub Actions badge with Shields.io (workflow file required for dynamic status image).

Parameters

owner string required
repo string required
workflow string? = null optional
branch string? = null optional

Returns

MarkdownBadgeBuilder

public MarkdownBadgeBuilder Coverage(string url) #

BadgeBuilder.cs:36

Adds a code coverage badge using Shields.io for Codecov.

Parameters

url string required

Returns

MarkdownBadgeBuilder

public MarkdownBadgeBuilder CoverageCodecov(string owner, string repo, string? branch = null) #

BadgeBuilder.cs:42

Adds a Codecov coverage badge and link for the given repo/branch.

Parameters

owner string required: GitHub owner or org.
repo string required: Repository name.
branch string? = null optional: Optional branch for the badge.

Returns

MarkdownBadgeBuilder

public MarkdownBadgeBuilder Custom(string text, string url, string? title = null) #

BadgeBuilder.cs:11

Adds a custom badge label linked to a URL.

Parameters

text string required
url string required
title string? = null optional

Returns

MarkdownBadgeBuilder

public MarkdownBadgeBuilder NuGet(string id) #

BadgeBuilder.cs:14

Adds a NuGet badge using Shields.io.

Parameters

id string required

Returns

MarkdownBadgeBuilder

Search OfficeIMO

MarkdownBadgeBuilder

Inheritance

Usage

Returned or exposed by 6

Accepted by parameters 1

Methods

Inherited Methods