Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.
TiddlyWiki is 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.
Learn more and see it in action at https://tiddlywiki.com/
Developer documentation is in progress at https://tiddlywiki.com/dev/
The TiddlyWiki discussion groups are mailing lists for talking about TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.
Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to mailto:tiddlywiki+subscribe@googlegroups.com or mailto:tiddlywikidev+subscribe@googlegroups.com.
Note that you do not need a Google Account to join the discussion groups. Subscribe by sending an email to mailto:tiddlywiki+subscribe@googlegroups.com or mailto:tiddlywikidev+subscribe@googlegroups.com.
New releases of TiddlyWiki, TiddlyDesktop and TiddlyFox are announced via the discussion groups and Twitter (you can also subscribe to an Atom/RSS feed of TiddlyWiki releases from GitHub)
There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: http://groups.google.com/group/tiddlywikidocs
apt-get install nodejs
on Debian/Ubuntu Linux or Termux for Android, or brew install node
on a Mac
npm install -g tiddlywiki
If it fails with an error you may need to re-run the command as an administrator:
sudo npm install -g tiddlywiki
(Mac/Linux)
tiddlywiki --version
tiddlywiki mynewwiki --init server
to create a folder for a new wiki that includes server-related componentstiddlywiki mynewwiki --listen
to start TiddlyWikitiddlywiki mynewwiki --build index
The -g
flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
If you are using Debian or Debian-based Linux and you are receiving a node: command not found
error though node.js package is installed, you may need to create a symbolic link between nodejs
and node
. Consult your distro's manual and whereis
to correctly create a link. See github issue 1434
Example Debian v8.0: sudo ln -s /usr/bin/nodejs /usr/bin/node
You can also install prior versions like this:
npm install -g tiddlywiki@5.1.13
TiddlyWiki5 includes a set of Commands for use on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.
For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:
tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
Running tiddlywiki
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 TiddlyWikiFolder 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 --
.
tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]
New in: 5.1.18 Commands such as the ListenCommand that support large numbers of parameters can use NamedCommandParameters to make things less unwieldy. For example:
tiddlywiki wikipath --listen username=jeremy port=8090
See Commands for a full listing of the available commands.
If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:
npm update -g tiddlywiki
On Mac or Linux you'll need to add sudo like this:
sudo npm update -g tiddlywiki
This readme file was automatically generated by TiddlyWiki