mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-17 07:14:50 +00:00
Code Issues Releases Wiki Activity

Docs updates for new file locations

Browse Source
This commit is contained in:
Jermolene 2014-09-17 20:01:00 +01:00
parent c20e6b9d1e
commit c63488d155
2 changed files with 14 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
editions/tw5.com/tiddlers/features/Features.tid
View File

@ -1,5 +1,5 @@
created: 20130822172800000 created: 20130822172800000
modified: 20140912140558227 modified: 20140917185232877
tags: TableOfContents tags: TableOfContents
title: Features title: Features
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -27,10 +27,10 @@ Further information about specific TiddlyWiki features:
* Clone existing tiddlers (for example, <$button message="tm-new-tiddler" param=<<currentTiddler>>>clone this tiddler</$button>) * Clone existing tiddlers (for example, <$button message="tm-new-tiddler" param=<<currentTiddler>>>clone this tiddler</$button>)
* TiddlyWiki is [[surprisingly scalable|Scalability]] to many thousands of tiddlers and megabytes of content * TiddlyWiki is [[surprisingly scalable|Scalability]] to many thousands of tiddlers and megabytes of content
* Try out the <$button message="tm-full-screen">full screen support</$button> * Try out the <$button message="tm-full-screen">full screen support</$button>
* Explore the [[D3.js visualisation plugin|http://tiddlywiki.com/d3demo.html]] * Explore the [[D3.js visualisation plugin|http://tiddlywiki.com/plugins/tiddlwiki/d3/index.html]]
* [[CodeMirror support via a plugin|http://tiddlywiki.com/codemirrordemo.html]] * [[CodeMirror support via a plugin|http://tiddlywiki.com/plugins/tiddlwiki/codemirror/index.html]]
* [[Markdown support via a plugin|http://tiddlywiki.com/markdowndemo.html]] * [[Markdown support via a plugin|http://tiddlywiki.com/plugins/tiddlwiki/markdown/index.html]]
* [[Classic TiddlyWiki markup support via a plugin|http://tiddlywiki.com/classicparserdemo.html]] * [[Classic TiddlyWiki markup support via a plugin|http://tiddlywiki.com/plugins/tiddlwiki/tw2parser/index.html]]
* Many internal improvements: * Many internal improvements:
** TiddlyWiki can now be run under [[Node.js]] as well as in the browser, allowing it to be used as a personal web server ** TiddlyWiki can now be run under [[Node.js]] as well as in the browser, allowing it to be used as a personal web server
** An elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules ** An elegant [[microkernel architecture|PluginMechanism]], that allows infinite customisation by replacing and augmenting the core modules

26
editions/tw5.com/tiddlers/nodejs/Scripts for TiddlyWiki on Node.js.tid
View File

@ -1,5 +1,5 @@
created: 20131219100637788 created: 20131219100637788
modified: 20140912141623230 modified: 20140917190022854
tags: [[TiddlyWiki on Node.js]] tags: [[TiddlyWiki on Node.js]]
title: Scripts for TiddlyWiki on Node.js title: Scripts for TiddlyWiki on Node.js
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -10,7 +10,7 @@ The TiddlyWiki5 repository contains several scripts in the `bin` folder that are
All the scripts expect to be run from the root folder of the repository. All the scripts expect to be run from the root folder of the repository.
!! `bld`: builds tw5.com !! `fullbld`: builds tw5.com
This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com. This script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
@ -24,33 +24,25 @@ By default, files are output to a folder called `jermolene.github.com`, sibling
+-- /jermolene.github.com/ - Directory for output files +-- /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`. 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 `fullbld`.
The files output by `bld` are: `fullbld` also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)
* `readme.md` main readme file, output to the TiddlyWiki5 directory
* `index.html` TiddlyWiki5 standalone HTML file with content from the `tw5.com` edition
* `empty.html` TiddlyWiki5 standalone HTML file with no content
* `encrypted.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` edition
* `static/*.html` and `static/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`: serves tw5.com
``` ```
./bin/serve.sh <username> [<password>] ./bin/serve.sh -h
./bin/serve.sh [edition dir] [username] [password] [host] [port]
``` ```
Or: Or:
``` ```
./bin/serve.cmd <username> [<password>] ./bin/serve.cmd -h
./bin/serve.cmd [edition dir] [username] [password] [host] [port]
``` ```
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. 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.
To experiment with this configuration, run the script and then visit `http://127.0.0.1:8080` in a browser. To experiment with this configuration, run the script and then visit `http://127.0.0.1:8080` in a browser.