From 9093f04ba3c0c8eecaae49c2e648d25d98c51403 Mon Sep 17 00:00:00 2001
From: Jermolene You can override the build output directory by defining the environment variable The files output by Or: This script starts TiddlyWiki5 running as an HTTP server with the content from the To experiment with this configuration, run the script and then visit Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen). This script runs the Or: This script serves the This script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base. This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them ( These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.
- You can override the build output directory by defining the environment variable The files output by Or: This script starts TiddlyWiki5 running as an HTTP server with the content from the To experiment with this configuration, run the script and then visit Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen). This script runs the Or: This script serves the This script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base. This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them ( These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5. Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed in a "non-linear" way, using tags, hyperlinks, and many other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one pre-set organizational structure. You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful Node.js application that treats each of your notes as a separate file and accesses them through a central hub. How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation, listed below, then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just follow our simple instructions and try it out for yourself! Running TiddlyWiki on Node.js brings several important benefits over and above the single file version: If it fails with an error you may need to re-run the command as an administrator: The A slightly different method for installation is recommended if you plan on forking the source code in order to study it or contribute to it. See Working with the TiddlyWiki5 repository.
- 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: Running 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 The available commands are:TW5_BUILD_OUTPUT
. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes bld
.bld
are:readme.md
main readme file, output to the TiddlyWiki5 directoryindex.html
TiddlyWiki5 standalone HTML file with content from the tw5.com
editionempty.html
TiddlyWiki5 standalone HTML file with no contentencrypted.html
TiddlyWiki5 standalone HTML file encrypted with the password password
test.html
TiddlyWiki5 browser-based test suite (see TestingMechanism)static.html
static HTML version of the DefaultTiddlers of the tw5.com
editionstatic/*.html
and static/static.css
static HTML versions of individual tiddlersbld
also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)serve
: serves tw5.com./bin/serve.sh <username> [<password>]
./bin/serve.cmd <username> [<password>]
tw5.com-server
edition. By default, the Node.js serves on port 8080. If the optional username
parameter is provided, it is used for signing edits. If the password
is provided then HTTP basic authentication is used.http://127.0.0.1:8080
in a browser.test
: build and run teststest
edition of TiddlyWiki on the server to perform the server-side tests and to build test.html
for running the tests in the browser.lazy
: serves tw5.com with lazily loaded images./bin/lazy.sh <username> [<password>]
./bin/lazy.cmd <username> [<password>]
tw5.com-server
edition content with LazyLoading applied to images.wbld
: builds TiddlyWiki for TiddlyWeb2bld
: builds TiddlyWiki 2.6.5diff
is used for *nix, fc
for Windows).deploy
& verbump
: deploy TiddlyWiki and bump the TiddlyWiki version numberTW5_BUILD_OUTPUT
. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes bld
.bld
are:readme.md
main readme file, output to the TiddlyWiki5 directoryindex.html
TiddlyWiki5 standalone HTML file with content from the tw5.com
editionempty.html
TiddlyWiki5 standalone HTML file with no contentencrypted.html
TiddlyWiki5 standalone HTML file encrypted with the password password
test.html
TiddlyWiki5 browser-based test suite (see TestingMechanism)static.html
static HTML version of the DefaultTiddlers of the tw5.com
editionstatic/*.html
and static/static.css
static HTML versions of individual tiddlersbld
also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)serve
: serves tw5.com./bin/serve.sh <username> [<password>]
./bin/serve.cmd <username> [<password>]
tw5.com-server
edition. By default, the Node.js serves on port 8080. If the optional username
parameter is provided, it is used for signing edits. If the password
is provided then HTTP basic authentication is used.http://127.0.0.1:8080
in a browser.test
: build and run teststest
edition of TiddlyWiki on the server to perform the server-side tests and to build test.html
for running the tests in the browser.lazy
: serves tw5.com with lazily loaded images./bin/lazy.sh <username> [<password>]
./bin/lazy.cmd <username> [<password>]
tw5.com-server
edition content with LazyLoading applied to images.wbld
: builds TiddlyWiki for TiddlyWeb2bld
: builds TiddlyWiki 2.6.5diff
is used for *nix, fc
for Windows).deploy
& verbump
: deploy TiddlyWiki and bump the TiddlyWiki version numberWelcome to TiddlyWiki
Getting started with TiddlyWiki under Node.js
Installation
npm install -g tiddlywiki
npm install -g tiddlywiki
(Windows)sudo npm install -g tiddlywiki
(Mac/Linux)tiddlywiki --version
5.0.8-beta
; you may also see other debugging information reported)tiddlywiki mynewwiki --init server
to create a folder for a new wiki that includes server-related componentstiddlywiki mynewwiki --server
to start TiddlyWiki-g
flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.Usage
tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
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.--
.tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]
See also:
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
This readme file was automatically generated by TiddlyWiki +
Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed to be non-linear, structuring content with stories, tags, hyperlinks, and other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one preset organizational structure.
You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful Node.js application that stores each of your notes as a separate file.
Note that TiddlyWiki is currently in beta, with the full release scheduled for Saturday, September 20th 2014
How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation listed below, and then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just follow our simple instructions and try it out for yourself!
Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:
For more information see:
This readme file was automatically generated by TiddlyWiki
\ No newline at end of file