Skip to content

TiddlyWiki5 packaged with the Bob plugin in a single executable file. Now in a much more usable repo! Please don't put issues with Bob here, this is for the part that do the compiling.

Notifications You must be signed in to change notification settings

OokTech/TW5-BobEXE

Repository files navigation

BobEXE

Single executable version of TiddlyWiki using Bob.

This a version of tiddlywiki using the Bob plugin

It is packaged as a single executable so you don't need to install anything to use the node version of tiddlywiki with multi-user support and the other features of Bob.

Instructions

Download the executable for your system and copy it to where you want your wiki to be. And then run it. (On osx or linux you may have to make it executable)

The executables are listed here: https://github.com/OokTech/TW5-BobEXE/releases

When you run the executable it will create a wiki folder for you, start the wiki server and then open up the wiki in your default browser.

After that it is the same as a normal tiddlywiki running Bob.

The default tiddler has some additional instructions.

Below here is only developer stuff, you should ignore it.

How to use this repo

  • Clone the repo
  • Initialise/clone the sub-modules
  • Install npm modules.
  • Install the node pkg module
  • Run buildExecutables.sh

Repo Structure

Folders:

  • plugins/ the repo for any plugins to be packaed with the executables. By default just the Bob plugin
    • plugins/OokTech/Bob - the submodule for the Bob plugin
    • plugins/OokTech/TWederBob - the submodule for the TWederBob plugin
  • editions/ just holds the index wiki edition used as the root wiki. By default just the edition for the IndexWiki
  • themes/ hold any themes to be packaged with the executables. By default empty
  • TiddlyWiki5/ the repo for TiddlyWiki as a submodule
  • buildExecutables.sh the script that builds the executables

Any plugins, themes or editions added to the appropriate folders listed above will be available to all wikis served. You still need to list the plugins in the tiddlywiki.info file as usual, but you don't have to worry about setting environment variables or anything like that if they are in the executable.

To get the repo at the correct version

git clone --branch <<TagName>> <<RepoURI>> --depth 1

Example:

git clone --branch v5.1.17 https://github.com/Jermolene/TiddlyWiki5.git --depth 1

About

TiddlyWiki5 packaged with the Bob plugin in a single executable file. Now in a much more usable repo! Please don't put issues with Bob here, this is for the part that do the compiling.

Resources

Stars

Watchers

Forks

Packages

No packages published