OfficeIMO

API Reference

Class

BadgeBuilder

Edit on GitHub
Namespace OfficeIMO.Markdown
Assembly OfficeIMO.Markdown
Source OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:11
Modifiers sealed

Helper to add common badges to README.

Inheritance

  • Object
  • BadgeBuilder

Methods

public BadgeBuilder Build(String url) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:21
Returns: BadgeBuilder

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

Parameters

url System.String requiredposition: 0
public BadgeBuilder BuildForGitHub(String owner, String repo, String workflow = null, String branch = null) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:24
Returns: BadgeBuilder

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

Parameters

owner System.String requiredposition: 0
repo System.String requiredposition: 1
workflow System.String = null optionalposition: 2
branch System.String = null optionalposition: 3
public BadgeBuilder Coverage(String url) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:36
Returns: BadgeBuilder

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

Parameters

url System.String requiredposition: 0
public BadgeBuilder CoverageCodecov(String owner, String repo, String branch = null) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:42
Returns: BadgeBuilder

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

Parameters

owner System.String requiredposition: 0
GitHub owner or org.
repo System.String requiredposition: 1
Repository name.
branch System.String = null optionalposition: 2
Optional branch for the badge.
public BadgeBuilder Custom(String text, String url, String title = null) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:11
Returns: BadgeBuilder

Adds a custom badge label linked to a URL.

Parameters

text System.String requiredposition: 0
url System.String requiredposition: 1
title System.String = null optionalposition: 2
public BadgeBuilder NuGet(String id) #
OfficeIMO.Markdown/Scaffold/BadgeBuilder.cs:14
Returns: BadgeBuilder

Adds a NuGet badge using Shields.io.

Parameters

id System.String requiredposition: 0