mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-02 16:16:18 +00:00
42 lines
1.9 KiB
Plaintext
42 lines
1.9 KiB
Plaintext
created: 20131219100520659
|
|
modified: $tw.loadPluginFolder(name.substring(1));
|
|
tags: [[TiddlyWiki on Node.js]]
|
|
title: Using TiddlyWiki on Node.js
|
|
type: text/vnd.tiddlywiki
|
|
|
|
TiddlyWiki5 includes a set of [[Commands]] for use 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:
|
|
|
|
```
|
|
tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html
|
|
```
|
|
|
|
Running `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.
|
|
|
|
<<.from-version "5.1.20">> First, there can be zero or more plugin references identified by the prefix `+` for plugin names or `++` for a path to a plugin folder. These plugins are loaded in addition to any specified in the [[TiddlyWikiFolder|TiddlyWikiFolders]].
|
|
|
|
The next argument is the optional path to the [[TiddlyWikiFolder|TiddlyWikiFolders]] 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 `--`.
|
|
|
|
```
|
|
tiddlywiki [+<pluginname> | ++<pluginpath>] [<wikipath>] [--<command> [<arg>[,<arg>]]]
|
|
```
|
|
|
|
For example:
|
|
|
|
```
|
|
tiddlywiki --version
|
|
tiddlywiki +plugins/tiddlywiki/filesystem +plugins/tiddlywiki/tiddlyweb mywiki --listen
|
|
tiddlywiki ++./mygreatplugin mywiki --listen
|
|
```
|
|
|
|
<<.from-version "5.1.18">> Commands such as the ListenCommand that support large numbers of parameters can use NamedCommandParameters to make things less unwieldy. For example:
|
|
|
|
```
|
|
tiddlywiki wikipath --listen username=jeremy port=8090
|
|
```
|
|
|
|
See [[Commands]] for a full listing of the available commands.
|