1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-04-01 16:26:57 +00:00

Add instructions for contribution ribbon

This commit is contained in:
Jermolene 2014-11-23 10:06:09 +00:00
parent 5329392dbe
commit 86329835c9

View File

@ -0,0 +1,23 @@
title: How to add a ribbon for GitHub contributions
modified: 20141123094403948
created: 20141123094403948
tags: Learning
When you edit a tiddler on http://tiddlywiki.com you will see a small ribbon inviting you to edit the source of the tiddler on GitHub.
If you are using Node.js, you can replicate this feature for your own TiddlyWiki-based site as follows:
# Make sure the following setting is included in the `tiddlywiki.info` file in your WikiFolder:
#> <code><pre>
"config": {
"retain-original-tiddler-path": true
}
</pre></code>
# Copy the tiddler [[$:/editions/tw5.com/EditTemplate/Sources]] to your wiki
# Make the following changes:
## Rename the tiddler to [[$:/ContributionBanner]]
## 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