74 KiB
Welcome to TiddlyWiki5
Welcome to TiddlyWiki, a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.
This is version 5.0.2-prerelease of TiddlyWiki, a major reboot currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.
TiddlyWiki is a free, open source project that depends on your love and support for their survival.
TiddlyWikiClassic - http://classic.tiddlywiki.com
On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and TiddlyWikiClassic is used to identify the older version.
The deep internal improvements mean that the new version of TiddlyWiki is not fully compatible with TiddlyWikiClassic. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as TiddlyWiki5 matures.
Getting started with TiddlyWiki under Node.js
Installation
For working on the command line with Node.js, you can install TiddlyWiki via npm:
npm -g install tiddlywiki
The -g flag causes TiddlyWiki to be installed globally.
Working with the TiddlyWiki5 repository
Working with the TiddlyWiki5 repository is recommended if you plan on forking the TiddlyWiki5 source code.
This readme file was automatically generated by TiddlyWiki5