2014-11-23 17:54:10 +00:00
title: How to add a banner for GitHub contributions
2014-11-23 10:06:09 +00:00
modified: 20141123094403948
created: 20141123094403948
tags: Learning
2017-11-11 11:56:20 +00:00
When you edit a tiddler on https://tiddlywiki.com you will see a small ribbon inviting you to edit the source of the tiddler on GitHub.
2014-11-23 10:06:09 +00:00
If you are using Node.js, you can replicate this feature for your own TiddlyWiki-based site as follows:
2020-11-30 21:34:00 +00:00
# Make sure the following setting is included in the <$link to="tiddlywiki.info Files">`tiddlywiki.info`</$link> file in your [[wiki folder|TiddlyWikiFolders]]:
2014-11-23 13:37:43 +00:00
#> <pre><code> "config": {
2014-11-23 10:06:09 +00:00
"retain-original-tiddler-path": true
2014-11-23 13:37:43 +00:00
}</code></pre>
2014-11-23 17:54:10 +00:00
# Copy the tiddler [[$:/ContributionBanner]] to your wiki
2014-11-23 10:06:09 +00:00
# Make the following changes:
## Adjust the GitHub link URL from https://github.com/Jermolene/TiddlyWiki5/edit/master/editions/tw5.com/tiddlers/ to point to your own GitHub repo
## Make sure the wording of the text starting "Can you help us improve this documentation?" is appropriate for your visitors
## Adjust the link to [[Improving TiddlyWiki Documentation]] to point to your own tiddler with instructions for the contribution procedure