diff --git a/bin/readme-bld.sh b/bin/readme-bld.sh index 198c3abd0..d90570e7e 100755 --- a/bin/readme-bld.sh +++ b/bin/readme-bld.sh @@ -10,6 +10,7 @@ fi # tw5.com readmes node $TW5_BUILD_TIDDLYWIKI \ + +plugins/tiddlywiki/multiwikiserver \ editions/tw5.com \ --verbose \ --output . \ diff --git a/readme.md b/readme.md index e91d74285..669bac524 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,8 @@ -

TiddlyWiki MultiWikiServer

UNDER DEVELOPMENT

This is a branch of TiddlyWiki that adds the MultiWikiServer plugin.

Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.

TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

Learn more and see it in action at https://tiddlywiki.com/

Developer documentation is in progress at https://tiddlywiki.com/dev/

Join the Community

+

TiddlyWiki MultiWikiServer

UNDER DEVELOPMENT

This is a branch of TiddlyWiki that adds the MultiWikiServer plugin.

This plugin extends the TiddlyWiki 5 server running on Node.js to be able to host multiple wikis that can share content or be independent.

Installation

git clone https://github.com/Jermolene/TiddlyWiki5.git --branch multi-wiki-support
+
+cd TiddlyWiki5
+
+npm install

To start the server:

npm start

The npm start command is a shortcut for the following command:

node ./tiddlywiki.js ./editions/multiwikiserver --listen

Then visit the administration interface in a browser:

Note that changes are written to the topmost bag in a recipe.

Note that until syncing is improved it is necessary to use "Get latest changes from the server" to speed up propogation of changes.

To run the tests:

./bin/test.sh

Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.

TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

Learn more and see it in action at https://tiddlywiki.com/

Developer documentation is in progress at https://tiddlywiki.com/dev/

Join the Community

Official Forums

The new official forum for talking about TiddlyWiki: requests for help, announcements of new releases and plugins, debating new features, or just sharing experiences. You can participate via the associated website, or subscribe via email.

https://talk.tiddlywiki.org/

Note that talk.tiddlywiki.org is a community run service that we host and maintain ourselves. The modest running costs are covered by community contributions.

For the convenience of existing users, we also continue to operate the original TiddlyWiki group (hosted on Google Groups since 2005):

https://groups.google.com/group/TiddlyWiki

Developer Forums

There are several resources for developers to learn more about TiddlyWiki and to discuss and contribute to its development.

Other Forums

Documentation

There is also a discussion group specifically for discussing TiddlyWiki documentation improvement initiatives: https://groups.google.com/group/tiddlywikidocs

Installing TiddlyWiki on Node.js

  1. Install Node.js
  2. Open a command line terminal and type:
    npm install -g tiddlywiki
    If it fails with an error you may need to re-run the command as an administrator:
    sudo npm install -g tiddlywiki (Mac/Linux)
  3. Ensure TiddlyWiki is installed by typing:
    tiddlywiki --version
  4. Try it out:
    1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
    2. tiddlywiki mynewwiki --listen to start TiddlyWiki
    3. Visit http://127.0.0.1:8080/ in your browser
    4. Try editing and creating tiddlers
  5. Optionally, make an offline copy: