Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.
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:[email protected].
There are several resources for developers to learn more about TiddlyWiki and to discuss and contribute to its development.
npm install -g tiddlywikiIf it fails with an error you may need to re-run the command as an administrator:
sudo npm install -g tiddlywiki(Mac/Linux)
tiddlywiki mynewwiki --build index
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
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 [email protected]
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
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.
New in: 5.1.20 First, there can be zero or more plugin references identified by the prefix
+ for plugin names or
++ for a path to a plugin folder. These plugins are loaded in addition to any specified in the TiddlyWikiFolder.
The next 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 [+<pluginname> | ++<pluginpath>] [<wikipath>] [--<command> [<arg>[,<arg>]]]
tiddlywiki --version tiddlywiki +plugins/tiddlywiki/filesystem +plugins/tiddlywiki/tiddlyweb mywiki --listen tiddlywiki ++./mygreatplugin mywiki --listen
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