mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00

A self-contained JavaScript wiki for the browser, Node.js, AWS Lambda etc.

Go to file

Jermolene 3da17c8e04 Lotsa docs updates		2013-11-29 17:20:10 +00:00
boot	Added primitive support for basic authentication	2013-11-28 14:03:08 +00:00
core	Add a class to the button icon SVGs	2013-11-29 17:11:48 +00:00
editions	Lotsa docs updates	2013-11-29 17:20:10 +00:00
licenses	Added Windows specific build scripts.	2013-11-19 19:57:05 -05:00
node_modules	First pass at integrating a Markdown parser	2013-11-01 16:06:08 +00:00
plugins/tiddlywiki	Make sure the github ribbon is behind any notifications	2013-11-26 22:46:36 +00:00
themes	Add a class to the button icon SVGs	2013-11-29 17:11:48 +00:00
.gitignore	Batch file cleanups	2012-11-29 21:30:53 +00:00
2bld.cmd	Added Windows specific build scripts.	2013-11-19 19:57:05 -05:00
2bld.sh	Get rid of the "new_" prefix we had on some methods	2013-11-08 08:51:14 +00:00
bld.cmd	Merge the dev material back into the main tw5.com wiki	2013-11-28 17:12:18 +00:00
bld.sh	Merge the dev material back into the main tw5.com wiki	2013-11-28 17:12:18 +00:00
contributing.md	Docs updates	2013-11-08 12:26:37 +00:00
deploy.cmd	Sync bld.cmd with latest bld.sh	2013-11-26 16:43:00 -05:00
deploy.sh	Update the deploy script to publish to NPM	2013-11-09 10:54:10 +00:00
ginsu.cmd	Sync bld.cmd with latest bld.sh	2013-11-26 16:43:00 -05:00
ginsu.sh	Get rid of the "new_" prefix we had on some methods	2013-11-08 08:51:14 +00:00
package.json	Update version number to 5.0.0-alpha.16-prerelease	2013-11-19 12:43:12 +00:00
readme.md	Lotsa docs updates	2013-11-29 17:20:10 +00:00
serve.cmd	Added primitive support for basic authentication	2013-11-28 14:03:08 +00:00
serve.sh	Added primitive support for basic authentication	2013-11-28 14:03:08 +00:00
test.cmd	Sync bld.cmd with latest bld.sh	2013-11-26 16:43:00 -05:00
test.sh	Reorganise the main file saving templates	2013-11-25 21:16:27 +00:00
tiddlywiki.js	Make require() compliant with CommonJS Modules/1.1	2013-10-12 13:44:09 -04:00
verbump.cmd	Sync bld.cmd with latest bld.sh	2013-11-26 16:43:00 -05:00
verbump.sh	Script for bumping the version number	2013-11-09 10:54:25 +00:00
wbld.cmd	Sync bld.cmd with latest bld.sh	2013-11-26 16:43:00 -05:00
wbld.sh	Get rid of the "new_" prefix we had on some methods	2013-11-08 08:51:14 +00:00

readme.md

Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the non-linear personal web notebook first released in 2004. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful Node.js application.

The deep internal improvements mean that TiddlyWiki5 is not fully compatible with older versions. Existing content will need massaging, while plugins and themes will have to be completely rewritten. The upgrade path will get smoother as TiddlyWiki5 matures.

The original TiddlyWiki Classic is still available at http://tiddlywiki.com/.

TiddlyWiki5 is currently in alpha at version 5.0.0-alpha.16-prerelease (see the detailed ReleaseHistory). There is a RoadMap for moving to beta and getting to the full release. It is a great time to get involved and support the future development of TiddlyWiki5.

TiddlyWiki is a free, open source project that depends on your love and support for its survival.

Getting started with TiddlyWiki under Node.js

Installation

For working on the command line with Node.js, you can install TiddlyWiki via npm:

npm -g install tiddlywiki

The -g flag causes TiddlyWiki to be installed globally.

Working with the TiddlyWiki5 repository

Working with the TiddlyWiki5 repository is recommended if you plan on forking the TiddlyWiki5 source code.

This readme file was automatically generated by TiddlyWiki5