diff --git a/readme.md b/readme.md index c7cf66d55..5b0a07682 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -
+Welcome to TiddlyWiki5
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful node.js application.
TiddlyWiki5 is currently in early beta, which is to say that it is useful but incomplete. You can get involved in the development on GitHub and the discussions on the TiddlyWikiDev Google Group.
Usage
TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on RecipeFiles, TiddlerFiles and TiddlyWikiFiles.
Usage:
node tiddlywiki.js <options>
The command line options are processed sequentially from left to right. Processing pauses during long operations, like loading a recipe file and all the subrecipes and tiddlers that it references, and then resumes with the next command line option in sequence. The following options are available:
--recipe <filepath>
Loads a specfied .recipe
file --load <filepath>
Load additional tiddlers from 2.x.x TiddlyWiki files (.html
), .tiddler
, .tid
, .json
or other files --savewiki <dirpath>
Saves all the loaded tiddlers as a single file TiddlyWiki called index.html
and an RSS feed called index.xml
in a new directory of the specified name --savetiddler <title> <filename> [<type>]
Save an individual tiddler as a specified MIME type, defaults to text/html
--savetiddlers <outdir>
Saves all the loaded tiddlers as .tid
files in the specified directory --savehtml <outdir>
Saves all the loaded tiddlers as static, unstyled .html
files in the specified directory --servewiki <port>
Serve the cooked TiddlyWiki over HTTP at /
--servetiddlers <port>
Serve individual tiddlers over HTTP at /tiddlertitle
--wikitest <dir>
Run wikification tests against the tiddlers in the given directory --dumpstore
Dump the TiddlyWiki store in JSON format --dumprecipe
Dump the current recipe in JSON format --verbose
verbose output, useful for debugging
Examples
This example loads the tiddlers from a TiddlyWiki HTML file and makes them available over HTTP:
node tiddlywiki.js --load mywiki.html --servewiki 127.0.0.1:8000