https://github.com/colearendt/gitlink

An R package to simplify placing GitHub links in your Shiny applications and R Markdown documents
https://github.com/colearendt/gitlink

github-buttons github-ribbon r r-package ribbon rmarkdown shiny

Last synced: 2 months ago
JSON representation

An R package to simplify placing GitHub links in your Shiny applications and R Markdown documents

• Host: GitHub
• URL: https://github.com/colearendt/gitlink
• Owner: colearendt
• License: other
• Created: 2018-12-08T20:20:01.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-28T05:32:55.000Z (about 5 years ago)
• Last Synced: 2024-04-25T08:21:21.946Z (8 months ago)
• Topics: github-buttons, github-ribbon, r, r-package, ribbon, rmarkdown, shiny
• Language: R
• Homepage:
• Size: 152 KB
• Stars: 22
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - colearendt/gitlink - An R package to simplify placing GitHub links in your Shiny applications and R Markdown documents (R)

README

        
gitlink

================

[![Travis build status](https://travis-ci.org/colearendt/gitlink.svg?branch=master)](https://travis-ci.org/colearendt/gitlink)

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/colearendt/gitlink?branch=master&svg=true)](https://ci.appveyor.com/project/colearendt/gitlink)

[![Coverage status](https://codecov.io/gh/colearendt/gitlink/branch/master/graph/badge.svg)](https://codecov.io/github/colearendt/gitlink?branch=master)

Include useful GitHub links in your Shiny applications and R Markdown

documents quickly and easily with the `gitlink` package\!

For example,

``` r

# 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](man/figures/gitlink-ex.png)

### Getting Started

The package can be installed from CRAN:

```r

install.packages("gitlink")

```

Or you can install the latest development version with:

``` r

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:

```r

  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](https://github.com/colearendt/gitlink/blob/master/.github/CODE_OF_CONDUCT.md).

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:

- https://buttons.github.io/

- https://github.com/tholman/github-corners/

- http://code.danyork.com/2011/09/29/how-to-create-github-style-fork-me-ribbons-using-only-css/

- https://unindented.org/articles/github-ribbon-using-css-transforms/

- https://ghbtns.com/