mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-09 11:29:58 +00:00

Jeremy Ruston e2b40c3a14 Preparing for release of v5.3.5

2024-07-10 14:07:12 +01:00

20 KiB

Raw Blame History

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/

Join the Community

Official Forums

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.

https://talk.tiddlywiki.org/

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):

https://groups.google.com/group/TiddlyWiki

Developer Forums

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
- Discussions are for Q&A and open-ended discussion
- Issues are for raising bug reports and proposing specific, actionable new ideas
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)

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

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
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)
Ensure TiddlyWiki is installed by typing:
tiddlywiki --version
- In response, you should see TiddlyWiki report its current version (eg "5.3.5". You may also see other debugging information reported.)
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
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 --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.

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

This readme file was automatically generated by TiddlyWiki

20 KiB Raw Blame History