mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 12:07:19 +00:00

A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.

Go to file

jeremy@jermolene.com ad575efdcc Update sortsub to evaluate the subfilter for each item in the list See the discussion here https://groups.google.com/d/msg/tiddlywiki/BqUFQ3v-fZw/U0F04CFFBQAJ		2020-04-25 15:22:24 +01:00
.github	Add pull request template	2020-04-07 20:26:46 +01:00
bin	Preparing for v5.1.23-prerelease	2020-04-15 16:23:19 +01:00
boot	Add new compare filter operator	2020-04-13 10:03:01 +01:00
core	Update sortsub to evaluate the subfilter for each item in the list	2020-04-25 15:22:24 +01:00
editions	Update sortsub to evaluate the subfilter for each item in the list	2020-04-25 15:22:24 +01:00
languages	Add chinese translations for AddPlugins things (#4546 )	2020-04-13 11:17:25 +01:00
licenses	Signing the CLA to start contributing (#4562 )	2020-04-14 21:52:11 +01:00
plugins/tiddlywiki	Twitter Plugin: Add warning if the wiki needs to be saved and reloaded	2020-04-21 21:22:13 +01:00
themes/tiddlywiki	Make selections follow palette colors (#4590 )	2020-04-22 10:46:36 +01:00
.gitignore	Ignore any node_modules directory	2015-12-19 18:47:58 +00:00
.jshintignore	Ignore any node_modules directory	2015-12-19 18:47:58 +00:00
.npmignore	Ignore any node_modules directory	2015-12-19 18:47:58 +00:00
.travis.yml	Travis-CI: Fix nvm failing to install Node.js v12.4.0	2020-04-06 11:05:45 +01:00
contributing.md	Add new readme build script, and update the readme build	2019-07-02 16:53:23 +01:00
license	Update copyright date in license	2020-04-14 15:19:03 +01:00
package.json	Update prerelease version number	2020-04-21 15:12:43 +01:00
readme.md	Update readme for v5.1.22	2020-04-15 16:11:52 +01:00
tiddlywiki.js	Make require() compliant with CommonJS Modules/1.1	2013-10-12 13:44:09 -04:00

readme.md

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

Users

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.

The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki
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.
- An enhanced group search facility is available on mail-archive.com
Watch recordings of our regular TiddlyWiki Hangouts
Follow @TiddlyWiki on Twitter for the latest news
New: Join us on our live chat at https://gitter.im/TiddlyWiki/public !
There is also a discord available at https://discord.gg/HFFZVQ8

Developers

The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev
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.
- An enhanced group search facility is available on mail-archive.com
Follow @TiddlyWiki on Twitter for the latest news
Get involved in the development on GitHub
Chat at https://gitter.im/TiddlyWiki/public (development room coming soon)

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)

Documentation

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

Installing TiddlyWiki on Node.js

Install Node.js
- either from your favourite package manager: typically apt-get install nodejs on Debian/Ubuntu Linux or Termux for Android, or brew install node on a Mac
- or directly from 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)
Check TiddlyWiki is installed by typing:
tiddlywiki --version
In response, you should see TiddlyWiki report its current version (eg "5.1.22"; 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.

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

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

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>]]]

For example:

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

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.

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