gitlink v0.1.3

0

Monthly downloads

0th

Percentile

Add 'Git' Links to Your Web Based Assets

Provides helpers to add 'Git' links to 'shiny' applications, 'rmarkdown' documents, and other 'HTML' based resources. This is most commonly used for 'GitHub' ribbons.

Readme

gitlink

Travis build status AppVeyor build status Coverage status

Include useful GitHub links in your Shiny applications and R Markdown documents quickly and easily with the gitlink package!

For example,

# note that this does not actually work for pure markdown documents like this README
ribbon_css("https://github.com/colearendt/gitlink")

demo Shiny application with "Fork Me on Github" ribbon

Getting Started

The package can be installed from CRAN:

install.packages("gitlink")

Or you can install the latest development version with:

devtools::install_github("colearendt/gitlink")

The ribbon_css function is highly customizable, as you can set any color, font, font-size, or other CSS properties with the parameters provided.

For example:

  ribbon_css("mylink.com", position = "left")
  ribbon_css("mylink.com", color = "black", font_color = "white", border_color = "white")
  ribbon_css("mylink.com", text = "Fork me PLEASE", fade = FALSE)

For more advanced examples, see ?ribbon_css

Code of Conduct

Please note that the 'gitlink' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Other Musings

Some interesting links that we have stumbled upon in our travels. Perhaps interesting for future or related work:

Functions in gitlink

Name Description
ribbon_img Build a GitHub Ribbon from an Image
ribbon_css Build a GitHub Ribbon with CSS
gitlink-package gitlink: Add git links to your web-based assets
No Results!

Last month downloads

Details

License MIT + file LICENSE
URL https://github.com/colearendt/gitlink
BugReports https://github.com/colearendt/gitlink/issues
Encoding UTF-8
Language en-US
LazyData true
RoxygenNote 6.1.1
NeedsCompilation no
Packaged 2019-07-19 12:44:55 UTC; carendt
Repository CRAN
Date/Publication 2019-07-23 12:20:02 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/gitlink)](http://www.rdocumentation.org/packages/gitlink)