![]() We no longer generate a separate “systemArea” for system tiddlers but we still need to import it for older wikis |
||
---|---|---|
boot | ||
core | ||
editions | ||
licenses | ||
node_modules | ||
plugins/tiddlywiki | ||
themes | ||
.gitignore | ||
2bld.cmd | ||
2bld.sh | ||
bld.cmd | ||
bld.sh | ||
contributing.md | ||
deploy.cmd | ||
deploy.sh | ||
ginsu.cmd | ||
ginsu.sh | ||
package.json | ||
readme.md | ||
serve.cmd | ||
serve.sh | ||
test.cmd | ||
test.sh | ||
tiddlywiki.js | ||
verbump.cmd | ||
verbump.sh | ||
wbld.cmd | ||
wbld.sh |
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.
TiddlyWiki5 is currently in alpha at version 5.0.0-alpha.18-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.
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/.
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