Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful node.js application.

TiddlyWiki is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks – tiddlers – and give them titles so that they can be structured with links, tags and macros. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.

TiddlyWiki5 has many improvements over the original. It is currently labelled alpha, meaning it is working but incomplete. It is a great time to get involved and support its future development. You can:

Getting started with TiddlyWiki under node.js

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:

node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html

Usage

Running tiddlywiki.js from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.

The first argument is the optional path to the wiki directory to be loaded. If not present, then the current directory is used.

The commands and their individual arguments follow, each command being identified by the prefix --.

node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]

Batch Files

For trying TiddlyWiki5 out under node.js, several batch files are provided:

Commands

The following commands are available:

DumpCommand

dump tiddlers

Dump the titles of the tiddlers in the wiki store 

--dump tiddlers

dump tiddler

Dump the fields of an individual tiddler 

--dump tiddler <title>

dump shadows

Dump the titles of the shadow tiddlers in the wiki store 

--dump shadows

dump config

Dump the current core configuration 

--dump config

LoadCommand

Load tiddlers from 2.x.x TiddlyWiki files ( .html), .tiddler, .tid, .json or other files 

--load <filepath>

SaveTiddlerCommand

Save an individual tiddler as a specified ContentType, defaults to text/html 

--savetiddler <title> <filename> [<type>]

ServerCommand

The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for GET, PUT and DELETE.

--server <port> <roottiddler> <rendertype> <servetype>

For example:

--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html

The parameters are:

--server <port> <roottiddler> <rendertype> <servetype>
  • port - port number to serve from (defaults to "8080")
  • roottiddler - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html")
  • rendertype - the content type to which the root tiddler should be rendered (defaults to "text/plain")
  • servetype - the content type with which the root tiddler should be served (defaults to "text/html")

VerboseCommand

Triggers verbose output, useful for debugging 

--verbose

VersionCommand

Displays the version number of TiddlyWiki.

--version

This readme file was automatically generated by TiddlyWiki5