Readme.md

November 24, 2024 ยท View on GitHub

Donations

The blog software allows you to integrate via different micro-transaction services. The following chapter will show you how to set up donations.

Ko-fi

You can use Ko-fi as a payment service to receive donations. To acquire the KofiToken as seen in the config above, head to widgets page, click on "Ko-fi Button". Now choose "Image" as the type. In the field below under Copy & Paste Code you see an <a href='https://ko-fi.com/XYZ' tag. Just take the XYZ part and put it into KofiToken.

GitHub Sponsor

Enables the usage of GitHub Sponsors as a payment service to receive donations. Only pass in your username. The button will use the following url: https://github.com/sponsors/{your-user-name}.

Patreon

Enables the usage of Patreon. Only pass the user name (public profile) as user name.

Configuration

"SupportMe": {
	"KofiToken": "ABC123",
	"GithubSponsorName": "your-tag-here",
	"PatreonName": "your-tag-here",
	"ShowUnderBlogPost": true,
	"ShowUnderIntroduction": true,
	"ShowInFooter": true,
	"ShowSupportMePage": true,
	"SupportMePageDescription": "Buy my book here: [My Blazor Book](https://google.com) or please contribute to my open-source project here: [My Awesome Repo](https://github.com) . This can be **markdown**."
}
PropertyTypeDescription
KofiTokenstringEnables the "Buy me a Coffee" button of Kofi. To aquire the token head down to the "Kofi" section
GithubSponsorNamestringEnables the "Github Sponsor" button which redirects to GitHub. Only pass in the user name instead of the url.
PatreonNamestringEnables the "Become a patreon" button that redirects to patreon.com. Only pass the user name (public profile) as user name.
ShowUnderBlogPostbooleanEnables the donation section with the configured services to show under blog posts.
ShowUnderIntroductionbooleanEnables the donation section with the configured services to show the introduction on the main page.
ShowInFooterbooleanEnables the donation section with the configured services to show on the blog's footer.
ShowSupportMePagebooleanEnables the Support Me page with shows the SupportMePageDescription as text then the configured donation buttons.
SupportMePageDescriptionstringShows on the Support Me page, can be markdown.