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/
Join the Community
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.
Note that talk.tiddlywiki.org is a community run service that we host and maintain ourselves. The modest running costs are covered by community contributions.
For the convenience of existing users, we also continue to operate the original TiddlyWiki group (hosted on Google Groups since 2005):
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
- The older TiddlyWikiDev Google Group is now closed in favour of GitHub Discussions but remains a useful archive: https://groups.google.com/group/TiddlyWikiDev
- An enhanced group search facility is available on mail-archive.com
- Follow @TiddlyWiki on Twitter for the latest news
- Chat at https://gitter.im/TiddlyWiki/public (development room coming soon)
- TiddlyWiki Subreddit
- Chat with Gitter at https://gitter.im/TiddlyWiki/public !
- Chat on Discord at https://discord.gg/HFFZVQ8
TiddlyWiki on Node.jsInstalling
- Install Node.js
- Linux: Debian/Ubuntu:
apt install nodejs
May need to be followed up by:
apt install npmArch Linux
pacman -S tiddlywiki
(installs node and tiddlywiki)
brew install node
- Open a command line terminal and type:
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)
- Ensure TiddlyWiki is installed by typing:
- In response, you should see TiddlyWiki report its current version (eg "5.2.3". You may also see other debugging information reported.)
- Try it out:
- Optionally, make an offline copy:
- click the save changes button in the sidebar, OR
tiddlywiki mynewwiki --build index
node: command not founderror though node.js package is installed, you may need to create a symbolic link between
node. Consult your distro's manual and
whereisto correctly create a link. See github issue 1434.
Example Debian v8.0:
sudo ln -s /usr/bin/nodejs /usr/bin/node
npm install -g email@example.com
TiddlyWiki on Node.jsUsing
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.
TiddlyWiki on Node.jsUpgrading
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
- 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
- Scripts for TiddlyWiki on Node.js
- Node.js on Termux
- tiddlywiki.files Files
- tiddlywiki.info Files
- 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