From 86329835c91cdad24b214ea09649dc9573f90cf6 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Sun, 23 Nov 2014 10:06:09 +0000 Subject: [PATCH] Add instructions for contribution ribbon --- ... add a ribbon for GitHub contributions.tid | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 editions/tw5.com/tiddlers/howtos/How to add a ribbon for GitHub contributions.tid diff --git a/editions/tw5.com/tiddlers/howtos/How to add a ribbon for GitHub contributions.tid b/editions/tw5.com/tiddlers/howtos/How to add a ribbon for GitHub contributions.tid new file mode 100644 index 000000000..754c51237 --- /dev/null +++ b/editions/tw5.com/tiddlers/howtos/How to add a ribbon for GitHub contributions.tid @@ -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: +#>
+	"config": {
+		"retain-original-tiddler-path": true
+	}
+
+# 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 + +