Skip to content

ribbon-studios/fork-me

Repository files navigation

NPM Version NPM Downloads Coveralls

CI Build Maintainability Semantic Release Code Style: Prettier

@ribbon-studios/fork-me

example

Usage

import { ForkMe } from '@ribbon-studios/fork-me';

export function MyApp() {
  return (
    <div>
      My super cool content.
      <ForkMe slug="ribbon-studios/fork-me" />
    </div>
  );
}

Properties

Name Description Optional?
slug The slug of your repository No
side The side you'd like the octocat to appear! Yes (defaults to 'right')
backgroundColor The ribbon color Yes (defaults to 'black')
color The octocat color Yes (defaults to 'white')
newTab Set this to false to make it open in the current tab. Yes (defaults to true)

Want to Contribute?