mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-01-22 23:16:53 +00:00
Code Issues Releases Wiki Activity
A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.
1,634 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%
f9e6a61450
Go to file
Jeremy Ruston f9e6a61450 Readme updates
2013-03-01 16:25:09 +00:00
core Adjust tiddler width 2013-03-01 09:13:23 +00:00
editions Readme updates 2013-03-01 16:25:09 +00:00
plugins/tiddlywiki Cleaning up recipe file access code 2013-03-01 09:13:44 +00:00
.gitignore Batch file cleanups 2012-11-29 21:30:53 +00:00
2bld.sh Update batch files to specify wikipath 2013-02-09 17:08:19 +00:00
bld.sh Update batch files to specify wikipath 2013-02-09 17:08:19 +00:00
dbld.sh Batch file cleanups 2012-11-29 21:30:53 +00:00
package.json Update version number 2013-01-31 10:19:46 +00:00
readme.md Readme updates 2013-03-01 16:25:09 +00:00
serve.sh Update batch files to specify wikipath 2013-02-09 17:08:19 +00:00
tiddlywiki.js Batch file cleanups 2012-11-29 21:30:53 +00:00
wbld.sh Batch file cleanups 2012-11-29 21:30:53 +00:00

readme.md

Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful node.js application.

TiddlyWiki is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks – tiddlers – and give them titles so that they can be structured with links, tags and macros. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.

TiddlyWiki5 has many improvements over the original. It is currently labelled alpha, meaning it is working but incomplete. It is the best possible time to get involved and support its future development. You can:

Usage

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:

node tiddlywiki.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html

Usage

Running tiddlywiki.js 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 wiki directory 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 --.

node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]]

Batch Files

For trying TiddlyWiki5 out under node.js, several batch files are provided:

Commands

The following commands are available:

This readme file was automatically generated by TiddlyWiki5