File | Date | Author | Commit |
---|---|---|---|
wiki | 2015-09-27 | Hegart Dmishiv | [b4c0c7] Delete BrowserTabTitle.tid |
.travis.yml | 2015-09-24 | danielo515 | [6b9cf7] travis and publish script files added |
LICENSE | 2015-09-24 | Daniel Rodríguez Rivero | [957fb4] Initial commit |
README.md | 2015-09-25 | Hegart Dmishiv | [354a3f] Update README.md |
publish.sh | 2015-09-24 | danielo515 | [6b9cf7] travis and publish script files added |
We all love Github pages. They are an easy,reliable and cheap way to host static sites. TiddlyWiki is a single page web application wiki that can be hosted as a single html file. It is an awesome unique application, and I strongly recommend you to check it out at TiddlyWiki.com. The problem with it is that there is not an easy fast way to host a tiddlywiki file on github pages... until now.
This repository is both a template and a set of instructions to host a tiddlywiki on your own Github pages repository. Following this instructions you will be able to have your own wiki up and runing in less than 10 minutes without any git
or Github Knowledge and without installing any software on your computer.
Using this work-flow has several advantages:
1. Github pages are absolutely free and reliable
2. Tiddlers are built from individual .tid
files
3. Built in changes history and diff
4. Github allows you to edit and add files directly from their web interface, so you don't have to install anything in your computer.
3. No git
or Github Knowledge required
The list of pre-requisites is quite small, and you only need to fit them once
* A Github account
* A Travis-ci account
This are the steps required for the first time setup. Once you have completed all the steps listed here for the first time it will be much faster to just add new wikis.
Personal access token
to allow our publish scripts to push to our github account. This is only needed on the first time setup. Go to Github's tokens management pageGenerate new token
repo
and public_repo
options are selectedGenerate token
. Here is an overview of this step:My Repositories
to put the forked repository under Travis management:Sync
button to refresh the list of repositories:GH_REF
, which is the url of **your forked repository without the https prefix and with a .git
extension. For this variable you can set to on
the Display value in build log
, so you can check that it is correct on every build. Click addGH_TOKEN
variable, but this time make sure that Display value in build log
is set to off for security reasons. Paste here the Github token we have generated previously:GH_EMAIL
variable. This should be the email you have used to register your account on github. After this process you should see something like this:current
tab.current
tab to see what is going on during build process. The build process happens every time you push a change to your repository and not before. An ongoing build looks like this:Editing tiddlers
section<your-git-username>.github.io/your-repo-name
to see the results of your buildOnce you have completed the first time setup, it is much easier to setup another wiki. Here is a summary of the required Steps:
1. Fork this repository:
2. Rename the repository to fit your needs.
3. Go to Travis-ci and sign in using your github account.
4. On the left side of your dashboard click the plus sign next to My Repositories
to put the forked repository under Travis management:
5. Locate the repository you have just forked and activate the "switch" to put it under Travis management.
6. If you don't find the repository you are looking for, click the Sync
button to refresh the list of repositories:
7. Setup the global variables
8. Edit/add the required tiddlers and make a push. This can be done directly on github.
You can just edit or add new tiddlers directly on github, which is quite comfortable, or you can use a markdown editor. Tiddlywiki sintax is not exactly markdown, but it is close enough to use it as a small reference and markdown editors usually helps you completing lists and provide preview.
I recommend you to use prose, which is the tool I have used to edit this README:
Authorize aplication
and authorize it on Githubwiki
>tiddlers
directory.tid
extension.To edit markdown files you have an better alternative which is dillinger. The drawback of dilinger is that it only recognices .md
files:
IMPORT FROM
Github
wiki
>tiddlers
directorySAVE TO
and select github