mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-24 02:27:19 +00:00
Code Issues Releases Wiki Activity
A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
7,163 Commits 101 Branches 68 Tags 90 MiB
JavaScript 96.9%
TeX 1.3%
Shell 0.9%
CSS 0.7%
Batchfile 0.1%
Other 0.1%
3959b1b89e
Go to file
Irene Knapp 3959b1b89e Add Google, Inc as a signer of the entity CLA. 
I emailed a PDF with an actual signature, a moment ago, to
jeremy@jermolene.com.  My understanding is that this signature would be valid
not just for me but for other Googlers who contribute to TiddlyWiki in future,
if there are any.  So I've omitted my personal name from the signature line -
I think this is probably the way it's supposed to be?  If you look at the PDF
you'll see that it's actually one of our lawyers who agreed to it, not me
as an individual.  I'll be using my @google.com email address for this and any
future patches, so record-keeping at TiddlyWiki's end shouldn't need a record
of GitHub usernames.
2015-12-21 15:00:05 -08:00
bin Add clean.sh for removing build output 2015-10-22 22:46:47 +01:00
boot Minor tweaks to boot kernel for AWS 2015-12-19 18:52:25 +00:00
core Merge pull request #1967 from Drakor/fixActionSetField 2015-12-21 22:17:51 +00:00
editions Remove modifier/modified/revision fields from #2037 2015-12-06 19:11:41 +00:00
languages fr-FR translation of strings related to Toolbar Button Style 2015-11-21 18:50:25 +01:00
licenses Add Google, Inc as a signer of the entity CLA. 2015-12-21 15:00:05 -08:00
plugins/tiddlywiki Add plugin wrappers for async and jszip 2015-12-19 18:47:42 +00:00
themes/tiddlywiki Fix search dropdown positioning 2015-12-20 08:53:29 +00: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
contributing.md Update readmes 2015-07-03 16:47:39 +01:00
package.json Prepare for 5.1.10 2015-07-06 11:23:49 +01:00
readme.md Update readmes 2015-07-03 16:47:39 +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:

    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.1.8"; 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.

If you are using Debian or Debian-based Linux and you are reciving 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

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