mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-30 13:29:56 +00:00
Code Issues Releases Wiki Activity
95bd694a65
TiddlyWiki5/bin
History
jeremy@jermolene.com d33e0a05e2 Preparing for v5.2.2-prerelease
2021-12-08 12:22:51 +00:00
..
build-site.sh Preparing for v5.2.2-prerelease 2021-12-08 12:22:51 +00:00
ci-pre-build.sh Add GitHub Actions workflow (#4793) 2020-08-28 17:31:57 +01:00
ci-push.sh Simplify ci-push.sh: end script on any error (#4886) 2020-10-26 16:58:21 +00:00
clean.sh Fix clean.sh 2016-01-03 18:02:49 +00:00
get-plugin-library-version-number CI: Fix plugin library version and build test.html 2019-01-08 10:34:50 +00:00
ginsu.cmd Move scripts into bin directory 2014-09-08 16:32:34 +01:00
ginsu.sh Move scripts into bin directory 2014-09-08 16:32:34 +01:00
lazy.cmd Move scripts into bin directory 2014-09-08 16:32:34 +01:00
lazy.sh Fix lazy.sh to serve the edition *tw5.com-server* 2016-08-16 15:46:53 +01:00
npm-publish.sh Bring over remaining scripts from build.jermolene.github.io 2019-08-09 10:30:26 +01:00
optimise-svgs.js Update SVG optimiser script 2021-04-16 09:20:39 +01:00
quick-bld.sh Include empty.html in the quick build 2019-09-24 13:23:21 +01:00
readme-bld.sh Add new readme build script, and update the readme build 2019-07-02 16:53:23 +01:00
readme.md Add new readme build script, and update the readme build 2019-07-02 16:53:23 +01:00
serve.cmd Fix typo 2014-10-12 16:57:01 +01:00
serve.sh Fix typo 2014-10-12 16:57:01 +01:00
tankbld.cmd Move scripts into bin directory 2014-09-08 16:32:34 +01:00
tankbld.sh Move scripts into bin directory 2014-09-08 16:32:34 +01:00
test.cmd Update test.cmd 2014-10-16 10:00:55 +01:00
test.sh CI: Investigate conditional stages 2019-01-05 11:59:16 +00:00
update-translation-from-html-file.sh Add script for updating language plugins from translators edition 2020-06-16 14:57:58 +01:00
verbump.sh Bring over remaining scripts from build.jermolene.github.io 2019-08-09 10:30:26 +01:00

readme.md

Script Files

The TiddlyWiki5 repository contains several scripts in the bin folder that you can use to automate common tasks, or as a useful starting point for your own scripts. See Scripts for building tiddlywiki.com for details of the scripts used to build and release https://tiddlywiki.com/.

All the scripts expect to be run from the root folder of the repository.

serve: serves tw5.com

./bin/serve.sh -h
./bin/serve.sh [edition dir] [username] [password] [host] [port]

Or:

./bin/serve.cmd -h
./bin/serve.cmd [edition dir] [username] [password] [host] [port]

This script starts TiddlyWiki5 running as an HTTP server, defaulting to 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. Run the script with the -h parameter to see online help.

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

./bin/lazy.sh <username> [<password>]

Or:

./bin/lazy.cmd <username> [<password>]

This script serves the tw5.com-server edition content with LazyLoading applied to images.