![]() Useful to be able to do `./bin/serve.sh "" "" 0.0.0.0` to listen on all network adaptors |
||
---|---|---|
.. | ||
2bld.cmd | ||
2bld.sh | ||
bld-languages.sh | ||
bld.cmd | ||
bld.sh | ||
deploy.cmd | ||
deploy.sh | ||
ginsu.cmd | ||
ginsu.sh | ||
lazy.cmd | ||
lazy.sh | ||
qbld.cmd | ||
qbld.sh | ||
readme.md | ||
serve.cmd | ||
serve.sh | ||
tankbld.cmd | ||
tankbld.sh | ||
test.cmd | ||
test.sh | ||
verbump.cmd | ||
verbump.sh | ||
wbld.cmd | ||
wbld.sh |
readme.md
Script Files
The TiddlyWiki5 repository contains several scripts that are used to build and deploy TiddlyWiki (.sh
for *nix and .cmd
for Windows). They can serve as a useful starting point for your own scripts.
All the scripts expect to be run from the root folder of the repository.
bld
: builds tw5.com
This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
By default, files are output to a folder called jermolene.github.com
, sibling to the TiddlyWiki5 repo directory. For example:
/TiddlyWork/ - Directory for working with TiddlyWiki5
|
+--+-- /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
|
+-- /jermolene.github.com/ - Directory for output files
You can override the build output directory by defining the environment variable 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
.
The files output by bld
are:
readme.md
main readme file, output to the TiddlyWiki5 directoryindex.html
TiddlyWiki5 standalone HTML file with content from thetw5.com
editionempty.html
TiddlyWiki5 standalone HTML file with no contentencrypted.html
TiddlyWiki5 standalone HTML file encrypted with the passwordpassword
test.html
TiddlyWiki5 browser-based test suite (see TestingMechanism)static.html
static HTML version of the DefaultTiddlers of thetw5.com
editionstatic/*.html
andstatic/static.css
static HTML versions of individual tiddlers
bld
also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)
serve
: serves tw5.com
serve.sh <username> [<password>]
Or:
serve.cmd <username> [<password>]
This script starts TiddlyWiki5 running as an HTTP server with the content from the 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.
To experiment with this configuration, run the script and then visit http://127.0.0.1:8080
in a browser.
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).
test
: build and run tests
This script runs the test
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
lazy.sh <username> [<password>]
Or:
lazy.cmd <username> [<password>]
This script serves the tw5.com-server
edition content with LazyLoading applied to images.
wbld
: builds TiddlyWiki for TiddlyWeb
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.
2bld
: builds TiddlyWiki 2.6.5
This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff
is used for *nix, fc
for Windows).
deploy
& verbump
: deploy TiddlyWiki and bump the TiddlyWiki version number
These scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5.