mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-30 09:13:16 +00:00

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

Go to file

Jermolene a9c209c62e Docs updates to get ready for beta There will be quite a lot more of these updates…		2013-12-11 13:13:37 +00:00
boot	Split out the parsing of semantic version strings	2013-12-02 09:57:19 +00:00
core	Fix file system behaviour for loading new tiddlers	2013-12-11 11:45:15 +00:00
editions	Docs updates to get ready for beta	2013-12-11 13:13:37 +00:00
licenses	Resolve conflict	2013-12-01 20:11:40 +00:00
node_modules	First pass at integrating a Markdown parser	2013-11-01 16:06:08 +00:00
plugins/tiddlywiki	Fix file system behaviour for loading new tiddlers	2013-12-11 11:45:15 +00:00
themes	Formatting for definition lists	2013-12-11 13:12:56 +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	Update template name for saving empty.html	2013-11-29 22:36:50 +00:00
bld.sh	Update template name for saving empty.html	2013-11-29 22:36:50 +00:00
contributing.md	Clarify location of license files	2013-11-30 16:25:15 +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	Prepare version number for 5.0.2 release	2013-12-07 08:59:16 +00:00
readme.md	Docs updates to get ready for beta	2013-12-11 13:13:37 +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	Update `verbump` script to include version number in commit message	2013-12-03 10:09:37 +00:00
verbump.sh	Update `verbump` script to include version number in commit message	2013-12-03 10:09:37 +00:00
wbld.cmd	Update template used for deployment to TiddlyWeb	2013-12-11 07:37:08 +00:00
wbld.sh	Update template used for deployment to TiddlyWeb	2013-12-11 07:37:08 +00:00

readme.md

Welcome to TiddlyWiki5

Welcome to TiddlyWiki, 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.

This is version 5.0.2-prerelease of TiddlyWiki, a major reboot currently in beta (see the detailed ReleaseHistory). There is a RoadMap for moving to the full release. It is a great time to get involved and support the future development of TiddlyWiki.

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

TiddlyWikiClassic - http://classic.tiddlywiki.com

On this site, unless noted otherwise, "TiddlyWiki" refers to the new version 5, and TiddlyWikiClassic is used to identify the older version.

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

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