Welcome

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.

Demo

Learn more and see it in action at https://tiddlywiki.com/

Developer Documentation

Developer documentation is in progress at https://tiddlywiki.com/dev/

Pull Request Previews

Pull request previews courtesy of Netlify

Join the Community

Official Forums

https://talk.tiddlywiki.org/

The new official forum 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.

talk.tiddlywiki.org is a community run service that we host and maintain ourselves. The modest running costs are covered by community contributions.

Google Groups

For the convenience of existing users, we also continue to operate the original TiddlyWiki group (hosted on Google Groups since 2005): https://groups.google.com/group/TiddlyWiki

Developer Forums

GitHub Stats

There are several resources for developers to learn more about TiddlyWiki and to discuss and contribute to its development.

• tiddlywiki.com/dev is the official developer documentation
• Get involved in the development on GitHub
• GitHub Discussions are for Q&A and open-ended discussion
• GitHub Issues are for raising bug reports and proposing specific, actionable new ideas
• The older TiddlyWikiDev Google Group is now closed in favour of Talk TiddlyWiki and GitHub Discussions
  • It remains a useful archive: https://groups.google.com/group/TiddlyWikiDev
    • An enhanced group search facility is available on mail-archive.com
• Chat at https://gitter.im/TiddlyWiki/public (development room coming soon)

Twitter

• Follow @TiddlyWiki on Twitter for the latest news

Other Forums

• TiddlyWiki Subreddit
• Chat with Gitter at https://gitter.im/TiddlyWiki/public !
• Chat on Discord at https://discord.gg/HFFZVQ8

Documentation

There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: https://groups.google.com/group/tiddlywikidocs

---

Installing TiddlyWiki on Node.js

TiddlyWiki is a SingleFileApplication, which is easy to use. For advanced users and developers there is a possibility to use a Node.js client / server configuration. This configuration is also used to build the TiddlyWiki SinglePageApplication

1. Install Node.js
   • Linux:

     Debian/Ubuntu:
     apt install nodejs
     May need to be followed up by:
     apt install npm

     Arch Linux
     yay -S tiddlywiki
     (installs node and tiddlywiki)

   • Mac

     brew install node

   • Android

     Termux for Android

   • Other

     See http://nodejs.org

2. Open a command line terminal and type:

   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)

3. Ensure TiddlyWiki is installed by typing:

   tiddlywiki --version

   • In response, you should see TiddlyWiki report its current version (eg "5.3.6-prerelease". You may also see other debugging information reported.)
4. Try it out:
   1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
   2. tiddlywiki mynewwiki --listen to start TiddlyWiki
   3. Visit http://127.0.0.1:8080/ in your browser
   4. Try editing and creating tiddlers
5. Optionally, make an offline copy:
   • click the save changes button in the sidebar, OR
   • tiddlywiki 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.

Warning

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

Tip

You can also install prior versions like this:
npm install -g tiddlywiki@5.1.13

Using TiddlyWiki on Node.js

TiddlyWiki5 includes a set of commands for use on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles.

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 --render 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.

Introduced in v5.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>]]]

For example:

tiddlywiki --version
tiddlywiki +plugins/tiddlywiki/filesystem +plugins/tiddlywiki/tiddlyweb mywiki --listen
tiddlywiki ++./mygreatplugin mywiki --listen

Introduced in v5.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.

Upgrading TiddlyWiki on Node.js

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

Also see

• Building TiddlyWikiClassic
• Customising Tiddler File Naming
• Environment Variables on Node.js
• Generating Static Sites with TiddlyWiki
• How to build a TiddlyWiki5 from individual tiddlers
• Installing custom plugins on Node.js
• Installing official plugins on Node.js
• Internet Information Services
• Installing TiddlyWiki Prerelease on Node.js
• MultiTiddlerFiles
• MultiTiddlerFileSyntax
• NamedCommandParameters
• Scripts for TiddlyWiki on Node.js
• Node.js on Termux
• TiddlerFiles
• tiddlywiki.files Files
• tiddlywiki.info Files
• TiddlyWikiFolders
• Uninstalling a plugin with Node.js
• Using a custom path prefix with the client-server edition
• Using TiddlyWiki for GitHub project documentation
• Working with the TiddlyWiki5 repository

This readme file was automatically generated by TiddlyWiki