kookma/tw5-github-saver

Direct saving Tiddlywiki 5.1.20+ to GitHub Pages using the new Tiddlywiki Github Saver Mechanism

TW5-GitHub-Saver

This is an demo shows how to use Tiddlywiki 5.1.20+ for creating websites and homepages using GitHub Pages.

The new GitHub Saver feature in TW 5.1.20 allows to open a Tiddlywiki hosted on a GitHub repository, edit it online and save back directly to GitHub. This is similar to what is used on Tiddlyspot a dedicated Tiddlywiki hosting service.

To see how TW5 + GitHub Saver works, see the demo at

https://kookma.github.io/TW5-GitHub-Saver/

tw5-github-saver's Issues

git pull and reload on opening file

I am using the same tiddly in a github repo on two different computers. Currently, I have to git pull before opening the file to ensure I have the latest version.

Could you add a functionality to git pull and reload the browser when you open the tiddly file?
Or a git pull-button?

Typo on the https://kookma.github.io/TW5-GitHub-Saver/#Quick%20Setup

Hello,

the tiddler https://kookma.github.io/TW5-GitHub-Saver/#Quick%20Setup contains a typo in the first URL.

From https://tiddlywiki.comI downloaded an empty edition and rename the empty.html downloaded to index.html
should be
From https://tiddlywiki.com downloaded an empty edition and rename the empty.html downloaded to index.html

There is an upper case i (I) at the end of the first URL.

SyncAdaptor version?

I'm using nodejs wiki, which will produce small git history, and human-readable diff. But I can't use nodejs wiki on the mobile.

So I think if there can be a sync adaptor that saves changed individual tiddler to github, this can be solved.

Clarify the Instructions

@kookma - thank you very much for this.

Here is my attempt to try it out, documenting my fumblings with the hope of improving the instructions (the README.md and the tiddler Tiddlywiki and GitHub Saver) and the procedure so that any TW user can do this with ease for a "Tiddlyspot alternative".

The biggest problems come from steps and assumptions that the instructions take for granted, thus:

First; It is not obvious that the demo is actually the instructions and that one should not download any "plugin", which is how one usually "extends" TW. IMO this should be noted in the README.

...but, after this, there's the immediate hit of the brick wall along with the all familiar feeling of hopelessness with github:

The Tiddlywiki and GitHub Saver tiddler, under "Setup GitHub repository" states:

If your index.html is going to be located in root directory of your repository, then use master branch as the source of GitHub pages
If the index.html is located in docs folder or wikis folder or other folder of choice, then select master branch/docs folder or master branch/wikis folder

Does my hope for a "tiddlyspot alternative" mean I will want multiple repositories or one repository with multiple "wikis folders"? I'm guessing the second (since it's called "wikis") but this needs clarification in the instructions.

...but then, what is a "wikis folder"???

And to Activate GitHub pages>"Choosing a publishing source", there is some gh instruction that I should choose a publishing source via (step 3) "None or Branch" or (step 4) select a "folder"... and I'm guessing I should select a "folder" because of the mention of "wiki folders"... but no "folders" options show up in my gh settings UI:

What to do?

Thank you.