mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-26 01:50:28 +00:00
Code Issues Releases Wiki Activity
A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
5,222 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%
5bb74319e1
Go to file
Jermolene 5bb74319e1 First pass at an edition for translators working in the browser 
The user interface needs some refinements but it shows the basic
principles.

The idea is that the translator would email their modified file, which
would then be merged into the core repo (some additional tools will be
helpful for this).

Fixes #984
2014-10-22 14:14:24 +01:00
bin Update test.cmd 2014-10-16 10:00:55 +01:00
boot Coloured warnings and errors under Node.js 2014-10-21 19:30:27 +01:00
core Extend the view widget to work with subtiddlers 2014-10-22 14:12:49 +01:00
editions First pass at an edition for translators working in the browser 2014-10-22 14:14:24 +01:00
languages Move search result count logic out of translations 2014-10-21 20:27:42 +01:00
licenses Update cla-individual.md 2014-10-18 11:05:17 -07:00
plugins/tiddlywiki First pass at an edition for translators working in the browser 2014-10-22 14:14:24 +01:00
themes/tiddlywiki Add theme tweaks for body text size 2014-10-22 08:32:36 +01: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.4 2014-10-20 18:54:07 +01:00
readme.md Readme update 2014-10-20 18:06:18 +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