Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 1.59 KB

README.md

File metadata and controls

51 lines (30 loc) · 1.59 KB

GitHub Buttons Build Status

Showcase your GitHub (repo's) success with these static buttons featuring links to your GitHub repo or profile page and up-to-date watch, fork, sponsor, and follower counts.

To get started, checkout https://ghbtns.com/!

Bug tracker

Have a bug? Please create an issue here on GitHub at https://github.com/mdo/github-buttons/issues.

Development

Clone the project and install dependencies before getting started. GitHub Buttons require Node.js, Ruby, and Bundler for local development.

npm i
bundle i

The GitHub buttons source code is split across three files in src/—the HTML, CSS, and JS. We use inline-source-cli and html-minifer to include it all in the compiled docs/github-btn.html file. To build this file:

npm run build

The https://ghbtns.com/ site is built with Jekyll. After installing the dependencies, you can run a local server:

bundle exec jekyll serve

Open http://127.0.0.1:4000 to browse locally.

See also

Twitter account

Keep up to date on announcements and more by following Mark on Twitter, @mdo.

Author

Mark Otto

Copyright and license

Copyright 2014-2022 Mark Otto. Released under the Apache 2.0 License.