mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 17:10:29 +00:00
Code Issues Releases Wiki Activity
A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
5,506 Commits 103 Branches 68 Tags 91 MiB
JavaScript 96.9%
TeX 1.3%
Shell 0.9%
CSS 0.7%
Batchfile 0.1%
Other 0.1%
4134392841
Go to file
Jermolene 4134392841 House style tweaks 
@giffmex - I’m sorry I should document these things but you’ll see I’ve
made some changes to punctuation and whitespace to match other tw5.com
tiddlers.

I’ve just noticed that the final bullet point ended abruptly with
“Finally, you will want a tiddler”. I’ve removed that line for the
moment.

The section “Add or remove shadow tiddlers from the user interface” is
actually describing a technique that is not recommended. If you remove
a tag from a shadow tiddler then you’ll have made a copy of it, which
means that it won’t be upgraded in future. It’s still worth
documenting, but with some warnings.

I do wonder whether the three sections deserve to be separate tiddlers.
Certainly the instructions for adding a toolbar button should be
directly addressable so that we can link directly to them on
http://tiddlywiki.com.
2014-11-23 14:00:24 +00:00
bin Update test.cmd 2014-10-16 10:00:55 +01:00
boot Allow includeWikis to be read-only 2014-11-13 12:28:51 +00:00
core Tweaked default tag background 2014-11-22 17:06:44 +00:00
editions House style tweaks 2014-11-23 14:00:24 +00:00
languages Reinstate translation for "download full wiki" 2014-11-18 14:05:23 +00:00
licenses Update cla-individual.md 2014-11-21 22:42:14 -07:00
plugins/tiddlywiki More icon tweaks 2014-11-13 21:39:38 +00:00
themes/tiddlywiki Tweak tiddler icon position 2014-11-22 09:43:01 +00:00
.gitignore some more german typos 2014-09-22 10:49:24 +00:00
.jshintignore JSHint obeisance for plugins folder 2014-08-30 21:32:55 +01:00
contributing.md Docs update 2014-10-14 15:15:56 +01:00
package.json Preparing for 5.1.5 2014-10-22 17:23:13 +01:00
readme.md Readme updates 2014-10-22 16:58:15 +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 http://tiddlywiki.com/

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

Installing TiddlyWiki on Node.js

  1. Install Node.js from 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:

    npm install -g tiddlywiki (Windows)

    sudo npm install -g tiddlywiki (Mac/Linux)

  3. Check TiddlyWiki is installed by typing:

    tiddlywiki --version

  4. In response, you should see TiddlyWiki report its current version (eg 5.0.8-beta; you may also see other debugging information reported)
  5. Try it out:
    1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
    2. tiddlywiki mynewwiki --server to start TiddlyWiki
    3. Visit http://127.0.0.1:8080/ in your browser
    4. Try editing and creating tiddlers

The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.

Using TiddlyWiki on Node.js

TiddlyWiki5 can be used 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.

The first 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 [<wikipath>] [--<command> [<arg>[,<arg>]]]

The available commands are:

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