Skip to content

A Note App that is local-first, uses tid/md pure text file, all-in-one with calendar/todo/diary widget, lazy-loading, backlink & outline & Zettelkasten, and syncs with the open-source TidGi-Desktop.

License

Notifications You must be signed in to change notification settings

tiddly-gittly/TidGi-Mobile

Repository files navigation

TidGi Mobile

Mobile Tiddlywiki app is A Note App that is local-first, uses tid/md pure text file, all-in-one with calendar/todo/diary widget, lazy-loading, backlink & outline & Zettelkasten, and syncs with the open-source TidGi-Desktop.

GitHub Releases

Screenshots

Adding Wiki by Scanning QR Code on TidGi-Desktop.

Adding Wiki by Scanning QR Wiki UI in TidGi Mobile
Screenshot of Adding Wiki by Scanning QR Screenshot of Wiki UI in TidGi Mobile

Switch Language on Preference, and edit server or wiki config in the list.

Preference Edit Wiki list item by long press
Screenshot of Adding Wiki by Scanning QR Screenshot of Wiki UI in TidGi Mobile

More Screenshots on metadata/en-US/images/phoneScreenshots/

Usage

Install tw-mobile-sync plugin.

tw-mobile-sync >= 0.6.0 works with TidGi-Mobile >= v0.3

How it stores and uses data

When syncing from a TidGi-Desktop app:

  1. HTML, contains some of core tw things like $:/boot and raw HTML created by $:/tags/RawMarkup
    1. To update the TiddlyWiki version or the raw markup, you need to perform a full-resync (delete and recreate)
  2. SQLite, When adding wiki, we fetch all skinny-tiddlers of your tid/md file, then store them in SQLite DB to speed up booting and save memory.
  3. JSON, When adding wiki, we fetch all plugins's full content as JSON, this will not be updated
  4. Files, binary files like images are stored as files on your phone.

Later, we use a Sync-Adaptor to only load the file you need lazily, to increase performance on a huge wiki. Also, reduce the memory and CPU consumption of your phone.

Drawbacks

Currently, only normal tiddlers in SQLite are certainly synced back to TidGi-Desktop. HTML Javascript tiddler, and JSON plugins are never tested (Feel free to have a try and report to me!). So if you want to add new plugins, you may need to backup data to Desktop, add plugins on Desktop, and perform a full resync (delete and recreate) from TidGi-Desktop (If this is not necessary, report to me!).

Permissions

All these features can be accessible from tiddlywiki plugin, so you can develop plugins to notify you about ToDo, or record locations of visited places, etc.

  1. Notification: We use notification to switch between full-screen wiki and menu, and also allow plugin to show notification.
  2. Location: To store server location, later can show them on a map.