Docs: Sponsor your GitHub Repositories

GitHub sponsor links

Sponsor your GitHub Repositories

Add a Sponsor button to any of your GitHub repos. When someone clicks it, they'll land directly on your Myhappr page.

1

In your GitHub repo, the root directory of your project, create the file .github/FUNDING.yml

If the .github folder doesn't exist yet, create it too.

2

Paste this into the file and commit

FUNDING.yml
custom: https://myhappr.com/your-username
3

Done, the Sponsor button appears automatically

GitHub shows a "Sponsor" button at the top of your repo. Anyone who clicks it lands on your Myhappr page. Works on all your repos, just add the same file to each one.

Why is the button not showing yet?

Even though you have committed the .github/FUNDING.yml file, GitHub requires you to manually toggle the "Sponsorships" feature on in your repository settings before the button displays.

Here are the quick steps to activate it:

1. Go to your repository homepage on GitHub.

2. In the top tabs (where it lists Code, Issues, Pull Requests, Actions...), click the Settings tab on the far right.

Navigating to GitHub repository settings

3. On the default General settings page, scroll down to the Features section.

4. Find the checkbox labeled Sponsorships (it says: "Display a sponsor button in this repository to showcase funding links...") and check it to enable.

Checking the Sponsorships feature checkbox in GitHub settings

5. Once you check that box, GitHub will instantly parse your FUNDING.yml file and display the pink Sponsor button in the right-hand sidebar of your repository (directly under the "About" section)!

GitHub repository showing the active Sponsor button and modal
GitHub repository showing the active Sponsor button and modal

This is what your repository visitors will see at the very top of your page:

GitHub repository showing the Sponsor button

Link your creator page from a repository

A GitHub funding link sends interested readers to your existing Myhappr page. The repository configuration contains a public page URL, not an API key or bank information. Choose the creator page you want to share, check that it opens for someone who is signed out, and use the configuration example below. This is an external support link; it does not connect Myhappr transactions to GitHub Sponsors billing.

Check the link after publishing

Commit the funding configuration to the repository where you want the support link to appear, then test the destination from GitHub. If you change your Myhappr username, review links you previously shared. Supporters complete checkout on Myhappr, with the displayed quote and the creator's existing payout settings. For another website, the embed guide explains how to add a button or widget instead of a repository funding link.