diff --git a/editions/tw5.com/tiddlers/Working with the TiddlyWiki5 repository video.tid b/editions/tw5.com/tiddlers/Working with the TiddlyWiki5 repository video.tid new file mode 100644 index 000000000..bdba130a7 --- /dev/null +++ b/editions/tw5.com/tiddlers/Working with the TiddlyWiki5 repository video.tid @@ -0,0 +1,9 @@ +created: 20140920133836765 +modified: 20140920134005568 +tags: [[Working with the TiddlyWiki5 repository]] +title: Working with the TiddlyWiki5 repository video +type: text/vnd.tiddlywiki + +Mario Pietsch has created a short video tutorial on [[working with the TiddlyWiki5 GitHub repository|Working with the TiddlyWiki5 repository]]. + + \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/nodejs/Using TiddlyWiki on Node.js.tid b/editions/tw5.com/tiddlers/nodejs/Using TiddlyWiki on Node.js.tid index b252c4809..958f65986 100644 --- a/editions/tw5.com/tiddlers/nodejs/Using TiddlyWiki on Node.js.tid +++ b/editions/tw5.com/tiddlers/nodejs/Using TiddlyWiki on Node.js.tid @@ -1,5 +1,5 @@ created: 20131219100520659 -modified: 20140912141913837 +modified: 20140920135025757 tags: [[TiddlyWiki on Node.js]] title: Using TiddlyWiki on Node.js type: text/vnd.tiddlywiki @@ -24,8 +24,4 @@ tiddlywiki [] [-- [[,]]] The available commands are: -
    <$list filter="[tag[command]]">
  • <$link to={{!!title}}><$view field="title"/>
- -See also: - -* [[Environment Variables on Node.js]] +<> diff --git a/editions/dev/tiddlers/from tw5.com/Working with the TiddlyWiki5 repository.tid b/editions/tw5.com/tiddlers/nodejs/Working with the TiddlyWiki5 repository.tid similarity index 56% rename from editions/dev/tiddlers/from tw5.com/Working with the TiddlyWiki5 repository.tid rename to editions/tw5.com/tiddlers/nodejs/Working with the TiddlyWiki5 repository.tid index 7a3866248..5c0d25bd7 100644 --- a/editions/dev/tiddlers/from tw5.com/Working with the TiddlyWiki5 repository.tid +++ b/editions/tw5.com/tiddlers/nodejs/Working with the TiddlyWiki5 repository.tid @@ -1,19 +1,18 @@ created: 20131219100444289 -modified: 20140104120500001 -tags: dev howto +modified: 20140920134404247 +tags: [[TiddlyWiki on Node.js]] title: Working with the TiddlyWiki5 repository type: text/vnd.tiddlywiki ! Introduction -Mario Pietsch has created a short video tutorial on working with the TiddlyWiki5 ~GitHub repository. +If you want to [[contribute|Contributing]] to TiddlyWiki's development, rather than [[installing TiddlyWiki in the usual way|Installing TiddlyWiki on Node.js]], you can work directly with the GitHub repository. - +Mario Pietsch has created a [[short video introduction|Working with the TiddlyWiki5 repository video]]. ! Setting Up -If you plan on working with the TiddlyWiki5 source code then follow these steps: - +# Create an account on GitHub if you don't already have one # Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5 # Clone a local copy of your fork # Open a command line terminal and change the current working directory to the root of the repo @@ -21,4 +20,4 @@ If you plan on working with the TiddlyWiki5 source code then follow these steps: After this procedure you can work with TiddlyWiki5 via [[npm]] as though it were installed in the usual way with `npm install -g tiddlywiki`. -See also [[Scripts for TiddlyWiki on Node.js]]. \ No newline at end of file +See also [[Scripts for TiddlyWiki on Node.js]]. diff --git a/editions/tw5.com/tiddlers/readme/ReadMe.tid b/editions/tw5.com/tiddlers/readme/ReadMe.tid index a0e6dc4ba..a58b1d453 100644 --- a/editions/tw5.com/tiddlers/readme/ReadMe.tid +++ b/editions/tw5.com/tiddlers/readme/ReadMe.tid @@ -1,19 +1,34 @@ created: 20131129094758194 -modified: 20131222161808390 +modified: 20140920135213536 title: ReadMe type: text/vnd.tiddlywiki \define tv-wikilink-template() http://tiddlywiki.com/static/$uri_doubleencoded$.html -! Welcome to TiddlyWiki -{{HelloThere}} +<$importvariables filter="[[$:/core/ui/PageMacros]] [all[shadows+tiddlers]tag[$:/tags/Macro]!has[draft.of]]"> -! Getting started with TiddlyWiki under Node.js +Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation. -{{TiddlyWiki on Node.js}} +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. -! Working with the TiddlyWiki5 repository +Learn more and see it in action at http://tiddlywiki.com -{{Working with the TiddlyWiki5 repository}} +! Installing TiddlyWiki on Node.js + +{{Installing TiddlyWiki on Node.js}} + +! Using TiddlyWiki on Node.js + +{{Using TiddlyWiki on Node.js}} + +! Upgrading TiddlyWiki on Node.js + +{{Upgrading TiddlyWiki on Node.js}} + +! Also see + +<> //This readme file was automatically generated by TiddlyWiki// + + diff --git a/readme.md b/readme.md index 9b613706d..be8e8301d 100644 --- a/readme.md +++ b/readme.md @@ -1,2 +1,168 @@ -

Welcome to TiddlyWiki

Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customise however you wish, and use to take / organise / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed to be non-linear, structuring content with stories, tags, hyperlinks, and other features, so that you can organise and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one preset organisational structure.

You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful Node.js application that stores each of your notes as a separate file.

Note that TiddlyWiki is currently in beta, with the full release scheduled for Saturday, September 20th 2014

How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation listed below, and then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just follow our simple instructions and try it out for yourself!

Getting started with TiddlyWiki under Node.js

Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:

  • You can edit your content on any suitably compatible HTML5 browser, including smartphones and tablets
  • Individual tiddlers are stored in separate files, which you can organise as you wish
  • The ability to build multiple wikis that blend different combinations of shared and unique content

For more information see:

Working with the TiddlyWiki5 repository

This readme file was automatically generated by TiddlyWiki -

\ No newline at end of file +

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 http://tiddlywiki.com

Installing TiddlyWiki on Node.js

  1. Install Node.js from http://nodejs.org
  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:

    npm install -g tiddlywiki (Windows)

    sudo npm install -g tiddlywiki (Mac/Linux)

  3. Check TiddlyWiki is installed by typing:

    tiddlywiki --version

  4. In response, you should see TiddlyWiki report its current version (eg 5.0.8-beta; you may also see other debugging information reported)
  5. Try it out:
    1. tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related components
    2. tiddlywiki mynewwiki --server to start TiddlyWiki
    3. Visit http://127.0.0.1:8080/ in your browser
    4. Try editing and creating tiddlers

The -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it. +

Using TiddlyWiki on Node.js

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.

For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:

tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html

Running tiddlywiki from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.

The first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.

The commands and their individual arguments follow, each command being identified by the prefix --.

tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]

The available commands are:

Upgrading TiddlyWiki on Node.js

If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:

npm update -g tiddlywiki

On Mac or Linux you'll need to add sudo like this:

sudo npm update -g tiddlywiki

Also see

This readme file was automatically generated by TiddlyWiki

\ No newline at end of file