ribbon_img: Build a GitHub Ribbon from an Image

Description Usage Arguments Details Value See Also

View source: R/ribbon.R

Description

Publicly available ribbon images began the "GitHub ribbon craze." This is a helper function that client-side retrieves these images. As a result, only certain colors are available. ribbon_css is usually preferred for many reasons.

Usage

1
2
3
ribbon_img(link, position = "right", color = "white")

get_color_lookup()

Arguments

link

The URL that the ribbon will link to

position

The position to place the ribbon in (either "left" or "right")

color

The color for the ribbon. One of get_color_lookup()

Details

NOTE that this creates a dependency on these image files, which are hosted publicly by GitHub on AWS.

Value

HTML that can be injected into any HTML output

See Also

ribbon_css


colearendt/ribbon documentation built on Dec. 2, 2019, 4:25 a.m.