[!CAUTION]
This VS Code extension will modify tidders in Tiddlywiki. Use it with caution,
This extension is in the very early stages of development and may not be stable,
Create a backup and test it before using.
tiddlyedit
tiddlyedit is a Visual Studio Code extension that streamlines editing tiddlers in TiddlyWiki configured with node.js.
Features
Search Tiddlers: Search for tiddlers using a search bar.
Syntax Highlighting: Enhanced readability for TiddlyWiki markup using TiddlyWiki5 Syntax.
Edit Tiddlers: Quickly edit and save tiddlers.
Auto Completion: Auto complete using Auto Complete plugin for TiddlyWiki. Triggered by Ctrl+Space.
Meta Information: View tiddler metadata.
Bidirectional Edit and View: View a tiddler in the browser and send a tiddler from browser to edit it in VS Code.
Open sidebar panel using the TiddlyWiki Icon in the left sidebar.
Search Tiddlers using the search bar at the top of the sidebar. You can enter a search term to filter tiddlers. If no search term is provided, it will show the results of default filter.
The default filter is [all[tiddlers]!is[system]!is[shadow]!sort[modified]limit[10]], which can be configured in your VS Code settings.
You can also use a custom filter by entering it in the search bar. The filter is used if search term starts with [.
Open a tiddler to edit. The tiddler is saved into temporary folder with filename title.tid and content as tiddler text field.
Save your changes to update the tiddler in your TiddlyWiki instance through WebAPI.
Your browser will automatically refresh to show the updated tiddler. The sync interval is determined by the TiddlyWiki hidden configuration Sync Polling Interval.
Install tw-livebridge to enable bidirectional editing, i.e. Open a tiddler in the browser from VS Code and edit a tiddler in VS Code from the browser.
Extension Settings
tiddlyedit contributes the following settings:
tiddlyedit.host: Base URL of the TiddlyWiki server (e.g., http://127.0.0.1:8080).
tiddlyedit.recipe: Recipe name to use for TiddlyWiki (e.g., default).
You can configure these in your VS Code settings.
Configuration of TiddlyWiki
Reduce Sync Polling Interval from server to client through creating a config tiddler $:/config/SyncPollingInterval (e.g., 1000 for 1 second). The default value is 60000 (60 seconds).
Auto Complete plugin uses tag $:/tags/EC/AutoComplete/Trigger for triggers. Switched on the Hidden Setting Sync System Tiddlers by setting $:/config/SyncSystemTiddlersFromServer to yes to allow system tiddlers are returned by web API.
Release Notes
0.1.0
Open a tiddler in browser and edit a tiddler in vs code from browser.
Improved meta information display for tiddlers.
Auto completion using Auto Complete plugin for TiddlyWiki.
Added preview support for Tiddlers.
Improved syntax highlighting for macros and widgets.
