Skip to content

Gemini server and other utilities for TiddlyWiki5

Notifications You must be signed in to change notification settings

ento/tw5-gemini-plugin

Repository files navigation

This plugin includes:

  • Node.js command for spinning up a Gemini server that serves tiddlers
  • Parser module for viewing text/gemini Tiddlers

Usage

--gemini-listen command

tiddlywiki path/to/wiki --gemini-listen [param=value]

The command can be used in conjunction with the --listen command.

Parameters:

  • tls-key=required/path/to.key
  • tls-cert=required/path/to.crt
  • port=1965
  • host=127.0.0.1
  • root-tiddler=HelloGemini: Specify the title of the Tiddler to serve at /
  • debug-level=none: Set to any other string to enable request logging.
  • path-prefix=: Serve the wiki at the specified path.

Config:

  • $:/plugins/ento/gemini/config/filter: (default: none) Only serve Tiddlers that match this filter.

text/gemini parser

Set the type of tiddler to text/gemini.

See "5 The text/gemini media type" of the spec for available markups. Currently v0.14.2 of the spec is implemented.

Installation

If you don't need Node.js features, drag this link to your TiddlyWiki:

$:/plugins/ento/gemini

Otherwise, install the plugin through npm and point to it with TIDDLYWIKI_PLUGIN_PATH.

  1. Run npm install git+https://github.com/ento/tw5-gemini-plugin.git
  2. Edit tiddlywiki.info file of your wiki and add tw5-gemini-plugin to plugins
  3. Run the server with environment variables pointing at the plugin installation path:
export TIDDLYWIKI_PLUGIN_PATH=$(npm root)/tw5-gemini-plugin/src/plugins
export NODE_PATH=$(npm root)/tw5-gemini-plugin/node_modules
tiddlywiki ...