Skip to content

Tid, a simple TiddlyWiki autosaver that works out of the box

License

Notifications You must be signed in to change notification settings

RebelPotato/tid

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tid: a simple TiddlyWiki autosaver

Tid is a simple TiddlyWiki autosaver. It should work out of the box on every system with a web browser (untested but Windows works fine), nothing else required.

Using tid

Download tid.com from "Releases" and click to run.

By default, Tid edits a wiki named wiki.html in its folder and will open a tab in your web browser. To edit a wiki in another location, just drag it onto tid.com to "Open with tid.com".

Alternatively, after downloading tid.com, run in the shell of your choice:

tid.com your_wiki.html

where your_wiki.html is your wiki's filename. If the first method doesn't work, this will neither, but at least you'll see the error messages.

How does it work?

Tid is powered by redbean, a wonderful server that runs everywhere unmodified, blazing fast, as a single file, and allow you to build apps with the same properties.

Basically, Tiddlywiki can autosave itself if it's served on a WebDAV server, so Tid implements just enough of WebDAV (literally 20 lines of lua code, see index.lua) to convince Tiddlywiki to hand its data over.

For more details, see this blog post where I got most of my code from.

Tweaking and extending

Run:

bin/redbean-3.0.0.com -i build.lua

which bundles all necessary files from src into a copy of bin/redbean-3.0.0.com to create dist/tid.com.

Caveats

This is very much a hack, so caveats abound! That said, I've been using it for a couple of days and it works perfect, so I'm sure it won't trash your wiki or something.

When in doubt, don't hesitate to see the code for yourself. Or better yet, change it and open a pull request.

Credits

Credits to tiddly-bean, Rick Dillon, coderofsalvation for inspirations, and of course Justine Tunney for the awesome Redbean server.

About

Tid, a simple TiddlyWiki autosaver that works out of the box

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published