Skip to content

BarakChamo/rc-badges

Repository files navigation

Ribbons and badges for open source project made at RC.

What are the tags?

The Recurse Center project tags are small badges inspired by the 'Fork me on GitHub' ribbons used to promote RC through your open source projects. Built something awesome during your batch? Let people know by including a tag in your project pages or documentation.

Tags are available as self-contained HTML snippets that do not require any external resouces or as image tags for less flexible use-cases such as Markdown or Jekyll. All tags link to the Recurse Center homepage.

Tag examples

There are many types of available tags and the selection will keep growing. Check out the project page for the up-to-date collection of RC tags.

Examples of tags are:

RC Seal

Made with Love tag

Badges

Shields-style pill

How to use the tags?

Method 1: Code Snippets

Go to the tags project page and select a tag you want to embed in your page. Click Copy to Clipboard and the a snippet will be copied. The snippet includes all needed HTML, CSS and the logo SVG so it can display properly online or offline without any added resources.

Method 2: Image tag snippets

If you're using the tags in environments that don't allow <style> tags or custom CSS like in Markdown or Jekyll blogs you can use <img> snippets that use a PNG rendering of the tags. The images are still pretty light weight and should load quickly on your pages.

Method 3: Compoments

The tags will soon be available as components for React and Angular 1 & 2 (a bit later on).

To install the tags module: npm install rc-badges

How to build and contribute?

To build the tags run the webpack build command from the project's root folder: webpack -w. Webpack will watch the project files and re-compile on every change. Note that this is not the webpack-dev-server so to open the project simply run index.html in your browser.


About

Recurse Center ribbons, badges and tags

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published