mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-07-21 19:32:50 +00:00
Code Issues Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Jermolene 2013-12-19 16:45:13 +00:00
parent b659c65959
commit 1336058336
4 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
editions/tw5.com/tiddlers/commands/ServerCommand.tid
View File

@ -1,7 +1,10 @@
title: ServerCommand created: 20131219163923630
modified: 20131219164420569
tags: command tags: command
title: ServerCommand
type: text/vnd.tiddlywiki
The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage - in particular, TiddlyWiki5 is an old-school wiki in the sense that it offers no authentication. The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage.
At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
@ -23,5 +26,7 @@ If the password parameter is specified then the browser will prompt the user for
For example: For example:
``` ```
--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName --server 8080 $:/core/tiddlywiki5.template.html text/plain text/html MyUserName passw0rd
``` ```
To run multiple TiddlyWiki servers at the same time you'll need to put each one on a different port.

4
editions/tw5.com/tiddlers/dev/Installing TiddlyWiki on Node.js.tid
View File

@ -1,5 +1,5 @@
created: 20131219100608529 created: 20131219100608529
modified: 20131219100621831 modified: 20131219163547622
tags: howto tags: howto
title: Installing TiddlyWiki on Node.js title: Installing TiddlyWiki on Node.js
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -7,6 +7,8 @@ type: text/vnd.tiddlywiki
# Install [[Node.js]] from http://npmjs.org # Install [[Node.js]] from http://npmjs.org
# Open a command line terminal and type: # Open a command line terminal and type:
#> `npm -g install tiddlywiki` #> `npm -g install tiddlywiki`
#> If it fails with an error you may need to re-run the command as an administrator:
#> `sudo npm -g install tiddlywiki`
# Check TiddlyWiki is installed by typing: # Check TiddlyWiki is installed by typing:
#> `tiddlywiki --version` #> `tiddlywiki --version`
# In response, you should see TiddlyWiki report its current version (eg `5.0.4-beta`; you may also see other debugging information reported) # In response, you should see TiddlyWiki report its current version (eg `5.0.4-beta`; you may also see other debugging information reported)

8
editions/tw5.com/tiddlers/dev/Using TiddlyWiki on Node.js.tid
View File

@ -1,5 +1,5 @@
created: 20131219100520659 created: 20131219100520659
modified: 20131219100534483 modified: 20131219163807594
tags: howto tags: howto
title: Using TiddlyWiki on Node.js title: Using TiddlyWiki on Node.js
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
@ -19,5 +19,9 @@ The first argument is the optional path to the [[TiddlyWikiFolder|TiddlyWikiFold
The commands and their individual arguments follow, each command being identified by the prefix `--`. The commands and their individual arguments follow, each command being identified by the prefix `--`.
``` ```
node tiddlywiki.js [<wikipath>] [--<command> [<arg>[,<arg>]]] tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]
``` ```
The available commands are:
<ul><$list filter="[tag[command]]"><li><$link to={{!!title}}><$view field="title"/></$link></li></$list></ul>

10
editions/tw5.com/tiddlers/dev/Working with the TiddlyWiki5 repository.tid
View File

@ -1,14 +1,18 @@
created: 20131219100444289 created: 20131219100444289
modified: 20131219100506819 modified: 20131219163213430
tags: dev howto tags: dev howto
title: Working with the TiddlyWiki5 repository title: Working with the TiddlyWiki5 repository
type: text/vnd.tiddlywiki type: text/vnd.tiddlywiki
! Setting Up
If you plan on working with the TiddlyWiki5 source code then follow these steps: If you plan on working with the TiddlyWiki5 source code then follow these steps:
# Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5 # Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5
# Clone a local copy of the repo # Clone a local copy of your fork
# Open a command line terminal and change the current working directory to the root of the repo # Open a command line terminal and change the current working directory to the root of the repo
# Type `sudo npm link` to tell [[npm]] to use this copy of the repo as the globally installed one # Type `sudo npm link` to tell [[npm]] to use this copy of the repo as the globally installed one
After this procedure you can work with TiddlyWiki5 via [[npm]] as though it were installed in the usual way with `npm -g install tiddlywiki`. See also [[Scripts for TiddlyWiki on Node.js]]. After this procedure you can work with TiddlyWiki5 via [[npm]] as though it were installed in the usual way with `npm -g install tiddlywiki`.
See also [[Scripts for TiddlyWiki on Node.js]].