<p>Welcome to <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a>, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.</p><p><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> is a complete interactive wiki in <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/JavaScript.html">JavaScript</a>. 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 <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/WikiText.html">WikiText</a>.</p><p>Learn more and see it in action at <aclass="tc-tiddlylink-external"href="https://tiddlywiki.com/"rel="noopener noreferrer"target="_blank">https://tiddlywiki.com/</a></p><p>Developer documentation is in progress at <aclass="tc-tiddlylink-external"href="https://tiddlywiki.com/dev/"rel="noopener noreferrer"target="_blank">https://tiddlywiki.com/dev/</a></p><h1class="">Join the Community</h1><p>
<h2class="">Official Forums</h2><p>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.</p><p><aclass="tc-tiddlylink-external"href="https://talk.tiddlywiki.org/"rel="noopener noreferrer"target="_blank">https://talk.tiddlywiki.org/</a></p><p>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.</p><p>For the convenience of existing users, we also continue to operate the original TiddlyWiki group (hosted on Google Groups since 2005):</p><p><aclass="tc-tiddlylink-external"href="https://groups.google.com/group/TiddlyWiki"rel="noopener noreferrer"target="_blank">https://groups.google.com/group/TiddlyWiki</a></p><h2class="">Developer Forums</h2><p>There are several resources for developers to learn more about <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> and to discuss and contribute to its development.</p><ul><li><aclass="tc-tiddlylink-external"href="https://tiddlywiki.com/dev"rel="noopener noreferrer"target="_blank">tiddlywiki.com/dev</a> is the official developer documentation</li><li>Get involved in the <aclass="tc-tiddlylink-external"href="https://github.com/TiddlyWiki/TiddlyWiki5"rel="noopener noreferrer"target="_blank">development on GitHub</a><ul><li><imgclass=" tc-image-loading"src="https://repobeats.axiom.co/api/embed/5a3bb51fd1ebe84a2da5548f78d2d74e456cebf3.svg"></li><li><aclass="tc-tiddlylink-external"href="https://github.com/TiddlyWiki/TiddlyWiki5/discussions"rel="noopener noreferrer"target="_blank">Discussions</a> are for Q&A and open-ended discussion</li><li><aclass="tc-tiddlylink-external"href="https://github.com/TiddlyWiki/TiddlyWiki5/issues"rel="noopener noreferrer"target="_blank">Issues</a> are for raising bug reports and proposing specific, actionable new ideas</li></ul></li><li>The older TiddlyWikiDev Google Group is now closed in favour of <aclass="tc-tiddlylink-external"href="https://github.com/TiddlyWiki/TiddlyWiki5/discussions"rel="noopener noreferrer"target="_blank">GitHub Discussions</a> but remains a useful archive: <aclass="tc-tiddlylink-external"href="https://groups.google.com/group/TiddlyWikiDev"rel="noopener noreferrer"target="_blank">https://groups.google.com/group/TiddlyWikiDev</a><ul><li>An enhanced group search facility is available on <aclass="tc-tiddlylink-external"href="https://www.mail-archive.com/tiddlywikidev@googlegroups.com/"rel="noopener noreferrer"target="_blank">mail-archive.com</a></li></ul></li><li>Follow <aclass="tc-tiddlylink-external"href="http://twitter.com/#!/TiddlyWiki"rel="noopener noreferrer"target="_blank">@TiddlyWiki on Twitter</a> for the latest news</li><li>Chat at <aclass="tc-tiddlylink-external"href="https://gitter.im/TiddlyWiki/public"rel="noopener noreferrer"target="_blank">https://gitter.im/TiddlyWiki/public</a> (development room coming soon)</li></ul><h2class="">Other Forums</h2><ul><li><aclass="tc-tiddlylink-external"href="https://www.reddit.com/r/TiddlyWiki5/"rel="noopener noreferrer"target="_blank">TiddlyWiki Subreddit</a></li><li>Chat with Gitter at <aclass="tc-tiddlylink-external"href="https://gitter.im/TiddlyWiki/public"rel="noopener noreferrer"target="_blank">https://gitter.im/TiddlyWiki/public</a> !</li><li>Chat on Discord at <aclass="tc-tiddlylink-external"href="https://discord.gg/HFFZVQ8"rel="noopener noreferrer"target="_blank">https://discord.gg/HFFZVQ8</a></li></ul><h3class="">Documentation</h3><p>There is also a discussion group specifically for discussing <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> documentation improvement initiatives: <aclass="tc-tiddlylink-external"href="https://groups.google.com/group/tiddlywikidocs"rel="noopener noreferrer"target="
</p><h1class="">Installing <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><ol><li>Install <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Node.js.html">Node.js</a><ul><li>Linux: <blockquote><div><em>Debian/Ubuntu</em>:<br><code>apt install nodejs</code><br>May need to be followed up by:<br><code>apt install npm</code></div><div><em>Arch Linux</em><br><code>yay -S tiddlywiki</code><br>(installs node and tiddlywiki)</div></blockquote></li><li>Mac<blockquote><div><code>brew install node</code></div></blockquote></li><li>Android<blockquote><div><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Serving%2520TW5%2520from%2520Android.html">Termux for Android</a></div></blockquote></li><li>Other <blockquote><div>See <aclass="tc-tiddlylink-external"href="http://nodejs.org"rel="noopener noreferrer"target="_blank">http://nodejs.org</a></div></blockquote></li></ul></li><li>Open a command line terminal and type:<blockquote><div><code>npm install -g tiddlywiki</code></div><div>If it fails with an error you may need to re-run the command as an administrator:</div><div><code>sudo npm install -g tiddlywiki</code> (Mac/Linux)</div></blockquote></li><li>Ensure TiddlyWiki is installed by typing:<blockquote><div><code>tiddlywiki --version</code></div></blockquote><ul><li>In response, you should see <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> report its current version (eg "5.3.6-prerelease". You may also see other debugging information reported.)</li></ul></li><li>Try it out:<ol><li><code>tiddlywiki mynewwiki --init server</code> to create a folder for a new wiki that includes server-related components</li><li><code>tiddlywiki mynewwiki --listen</code> to start <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a></li><li>Visit <aclass="tc-tiddlylink-external"href="http://127.0.0.1:8080/"rel="noopener noreferrer"target="_blank">http://127.0.0.1:8080/</a> in your browser</li><li>Try editing and creating tiddlers</li></ol></li><li>Optionally, make an offline copy:<ul><li>click the <spanclass="doc-icon"><svgclass="tc-image-save-button-dynamic tc-image-button"height="22pt"viewBox="0 0 128 128"width="22pt">
</svg></span><strong>save changes</strong> button in the sidebar, <strong>OR</strong></li><li><code>tiddlywiki mynewwiki --build index</code></li></ul></li></ol><p>The <code>-g</code> flag causes <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> to be installed globally. Without it, <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> will only be available in the directory where you installed it.</p><p><divclass="doc-icon-block doc-warning"><div><strong>Warning</strong></div><divclass="doc-block-icon"><svgclass="tc-image-warning tc-image-button"height="22pt"viewBox="0 0 128 128"width="22pt"><pathd="M57.072 11c3.079-5.333 10.777-5.333 13.856 0l55.426 96c3.079 5.333-.77 12-6.928 12H8.574c-6.158 0-10.007-6.667-6.928-12l55.426-96zM64 37c-4.418 0-8 3.582-8 7.994v28.012C56 77.421 59.59 81 64 81c4.418 0 8-3.582 8-7.994V44.994C72 40.579 68.41 37 64 37zm0 67a8 8 0 100-16 8 8 0 000 16z"fill-rule="evenodd"></path></svg></div>If you are using Debian or Debian-based Linux and you are receiving a <code>node: command not found</code> error though node.js package is installed, you may need to create a symbolic link between <code>nodejs</code> and <code>node</code>. Consult your distro's manual and <code>whereis</code> to correctly create a link. See github <aclass="tc-tiddlylink-external"href="http://github.com/TiddlyWiki/TiddlyWiki5/issues/1434"rel="noopener noreferrer"target="_blank">issue 1434</a>. <br><br>Example Debian v8.0: <code>sudo ln -s /usr/bin/nodejs /usr/bin/node</code></div></p><p><br>
</p><h1class="">Using <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p>TiddlyWiki5 includes a set of commands for use on the command line to perform an extensive set of operations based on <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolders</a>, <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlerFiles.html">TiddlerFiles</a>.</p><p>For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:</p><pre><code>tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</code></pre><p>Running <code>tiddlywiki</code> 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.</p><p><aclass="tc-tiddlylink tc-tiddlylink-resolves doc-from-version"href="https://tiddlywiki.com/static/Release%25205.1.20.html"><spanclass="tc-tiny-gap-right"><svgclass="tc-image-info-button tc-image-button"height="22pt"viewBox="0 0 128 128"width="22pt"><gfill-rule="evenodd"transform="translate(.05)"><pathd="M64 128c35.346 0 64-28.654 64-64 0-35.346-28.654-64-64-64C28.654 0 0 28.654 0 64c0 35.346 28.654 64 64 64zm0-16c26.51 0 48-21.49 48-48S90.51 16 64 16 16 37.49 16 64s21.49 48 48 48z"></path><circlecx="64"cy="32"r="8"></circle><rectheight="56"rx="8"width="16"x="56"y="48"></rect></g></svg></span>Introduced in v5.1.20</a> First, there can be zero or more plugin references identified by the prefix <code>+</code> for plugin names or <code>++</code> for a path to a plugin folder. These plugins are loaded in addition to any specified in the <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolder</a>.</p><p>The next argument is the optional path to the <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p>The commands and their individual arguments follow, each command being identified by the prefix <code>--</code>.</p><pre><code>tiddlywiki [+<pluginname> | ++<pluginpath>] [<wikipath>] [--<command> [<arg>[,<arg>]]]</code></pre><p>For example:</p><pre><code>tiddlywiki --version
tiddlywiki ++./mygreatplugin mywiki --listen</code></pre><p><aclass="tc-tiddlylink tc-tiddlylink-resolves doc-from-version"href="https://tiddlywiki.com/static/Release%25205.1.18.html"><spanclass="tc-tiny-gap-right"><svgclass="tc-image-info-button tc-image-button"height="22pt"viewBox="0 0 128 128"width="22pt"><gfill-rule="evenodd"transform="translate(.05)"><pathd="M64 128c35.346 0 64-28.654 64-64 0-35.346-28.654-64-64-64C28.654 0 0 28.654 0 64c0 35.346 28.654 64 64 64zm0-16c26.51 0 48-21.49 48-48S90.51 16 64 16 16 37.49 16 64s21.49 48 48 48z"></path><circlecx="64"cy="32"r="8"></circle><rectheight="56"rx="8"width="16"x="56"y="48"></rect></g></svg></span>Introduced in v5.1.18</a> Commands such as the <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/ListenCommand.html">ListenCommand</a> that support large numbers of parameters can use <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/NamedCommandParameters.html">NamedCommandParameters</a> to make things less unwieldy. For example:</p><pre><code>tiddlywiki wikipath --listen username=jeremy port=8090</code></pre><p>See <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Commands.html">Commands</a> for a full listing of the available commands.
</p><h1class="">Upgrading <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p>If you've installed <aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html">TiddlyWiki on Node.js</a> on the usual way, when a new version is released you can upgrade it with this command:</p><pre><code>npm update -g tiddlywiki</code></pre><p>On Mac or Linux you'll need to add <strong>sudo</strong> like this:</p><pre><code>sudo npm update -g tiddlywiki</code></pre><h1class="">Also see</h1><p><ulclass=""><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Building%2520TiddlyWikiClassic.html">Building TiddlyWikiClassic</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Customising%2520Tiddler%2520File%2520Naming.html">Customising Tiddler File Naming</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Environment%2520Variables%2520on%2520Node.js.html">Environment Variables on Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Generating%2520Static%2520Sites%2520with%2520TiddlyWiki.html">Generating Static Sites with TiddlyWiki</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/How%2520to%2520build%2520a%2520TiddlyWiki5%2520from%2520individual%2520tiddlers.html">How to build a TiddlyWiki5 from individual tiddlers</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Installing%2520custom%2520plugins%2520on%2520Node.js.html">Installing custom plugins on Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Installing%2520official%2520plugins%2520on%2520Node.js.html">Installing official plugins on Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Installing%2520TiddlyWiki%2520on%2520Microsoft%2520Internet%2520Information%2520Server.html">Internet Information Services</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Installing%2520TiddlyWiki%2520Prerelease%2520on%2520Node.js.html">Installing TiddlyWiki Prerelease on Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/MultiTiddlerFiles.html">MultiTiddlerFiles</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/MultiTiddlerFileSyntax.html">MultiTiddlerFileSyntax</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/NamedCommandParameters.html">NamedCommandParameters</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Scripts%2520for%2520TiddlyWiki%2520on%2520Node.js.html">Scripts for TiddlyWiki on Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Serving%2520TW5%2520from%2520Android.html">Node.js on Termux</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlerFiles.html">TiddlerFiles</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/tiddlywiki.files%2520Files.html">tiddlywiki.files Files</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/tiddlywiki.info%2520Files.html">tiddlywiki.info Files</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/TiddlyWikiFolders.html">TiddlyWikiFolders</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Uninstalling%2520a%2520plugin%2520with%2520Node.js.html">Uninstalling a plugin with Node.js</a></li><li><aclass="tc-tiddlylink tc-tiddlylink-resolves"href="https://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with%2520the%2520client-server
