mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-28 02:50:27 +00:00
Code Issues Releases Wiki Activity
ce3832e275
TiddlyWiki5/editions/tw5.com/tiddlers/nodejs/Installing TiddlyWiki on Node.js.tid

37 lines
1.8 KiB
Plaintext
Raw Normal View History

Docs updates
2013-12-19 10:08:14 +00:00
created: 20131219100608529
Doc: Adding comment to release notes re archived releases (#2882) * Doc: Adding comment to release notes to indicate where archived releases can be found. * Adding note about node.js to Release tiddler and Installing on Node.js tiddler
2017-06-09 14:33:24 +00:00
modified: 20170608135250979
Lots more docs updates
2014-09-12 15:05:37 +00:00
tags: [[TiddlyWiki on Node.js]]
Docs updates
2013-12-19 10:08:14 +00:00
title: Installing TiddlyWiki on Node.js
type: text/vnd.tiddlywiki
A third way to use TW5 on Android (#2415)
2016-04-30 20:47:09 +00:00
# Install [[Node.js]]
Update document in tiddlywiki.com edition * Add string '.htm' to 'Saving with TiddlyIE' * Change external links to match locale with wiki language * Add instructions for use to 'Saving on Android' * Change string in 'task' * Change instructions for use in 'Saving on iPad/iPhone' * Add newline to 'TiddlyDesktop Releases' * Remove caption from 'Serving TW5 from Android' * Change link to external in tiddlers which tagged 'Editions' * Remove string 'index.html' from 'Some of the things you can do with TiddlyWiki' * Change link 'TiddlyWiki Groups' to 'Forums' in tiddlers which tagged 'Community' * Remove CamelCase link 'TiddlyWiki' from tiddlers tagged 'Community' * Change string 'done' to 'Upgrade' in 'UpgradeMechanism' * Change buttons to images in 'How to export tiddlers' * Add images about buttons to tiddlers * Add quotation mark to text 'edit' in 'Signing the Contributor License Agreement' * Rename 'UsingSVG' to 'Using SVG' * Change link 'TypedBlockWikiText' to 'Typed Blocks in WikiText' in 'Using SVG' * Add tiddler 'Using Stamp' * Add 'rel="noopener noreferrer"' to external links * Add description about 'rel="noreferrer"' to 'HTML in WikiText' * Add link of prerelease version about translators edition, and how to translate on Node.js, in 'Translate TiddlyWiki into your language' * Change string 'dropdown' to 'tab' in 'Installing a plugin from the plugin library' * Add download button to 'Empty Edition'
2016-05-03 02:28:06 +00:00
#* either from your favourite package manager: typically `apt-get install nodejs` on Debian/Ubuntu Linux or Termux for Android, or `brew install node` on a Mac
A third way to use TW5 on Android (#2415)
2016-04-30 20:47:09 +00:00
#* or directly from http://nodejs.org
Docs updates
2013-12-19 10:08:14 +00:00
# Open a command line terminal and type:
Docs update
2013-12-31 11:36:51 +00:00
#> `npm install -g tiddlywiki`
Docs updates
2013-12-19 16:45:13 +00:00
#> If it fails with an error you may need to re-run the command as an administrator:
Clarify references to sudo
2014-01-02 21:47:01 +00:00
#> `sudo npm install -g tiddlywiki` (Mac/Linux)
Docs updates
2013-12-19 10:08:14 +00:00
# Check TiddlyWiki is installed by typing:
#> `tiddlywiki --version`
Docs tweaks
2015-03-25 22:15:51 +00:00
# In response, you should see TiddlyWiki report its current version (eg "<<version>>"; you may also see other debugging information reported)
Docs updates
2013-12-19 10:08:14 +00:00
# Try it out:
Docs updates
2014-02-24 14:09:29 +00:00
## `tiddlywiki mynewwiki --init server` to create a folder for a new wiki that includes server-related components
## `tiddlywiki mynewwiki --server` to start TiddlyWiki
Switch to using 127.0.0.1 in docs
2014-01-02 20:07:05 +00:00
## Visit http://127.0.0.1:8080/ in your browser
Docs updates
2013-12-19 10:08:14 +00:00
## Try editing and creating tiddlers
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
# Optionally, make an offline copy:
Update tiddlywiki.com edition (#2454) * Change button texts to latest version * Move tiddler files to appropriate categorys
2016-05-20 13:46:11 +00:00
#* click the {{$:/core/images/save-button}} ''save changes'' button in the sidebar, ''OR''
Add missing wiki directory to command example (#2950) All the other commands seem to assume that the user is not in the wiki directory, but rather in the parent directory: `tiddlywiki mynewwiki --init server` and `tiddlywiki mynewwiki --server`. This is why `tiddlywiki --build index` fails. A solution to this problem is to add the wiki name to the command.
2017-09-16 14:04:27 +00:00
#* `tiddlywiki mynewwiki --build index`
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
Docs updates
2013-12-19 10:08:14 +00:00
The `-g` flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
Added text notifying users of issue #1434
2015-04-28 02:31:18 +00:00
Improvements to Android and fr-FR docs (#2418) * A third way to use TW5 on Android small improvements to Android/Node.js doc tiddlers * fr-FR translation for the link button * replace _ with space in file name
2016-05-02 10:08:27 +00:00
If you are using Debian or Debian-based Linux and you are receiving a `node: command not found` error though node.js package is installed, you may need to create a symbolic link between `nodejs` and `node`. Consult your distro's manual and `whereis` to correctly create a link. See github [[issue 1434|http://github.com/Jermolene/TiddlyWiki5/issues/1434]]
Added text notifying users of issue #1434
2015-04-28 02:31:18 +00:00
Add build targets to server edition Define for the server edition the same build targets as for the empty edition, but using the correct template so that the "offline" version (target "index") works correctly when accessed via HTTP. With this, `tiddlywiki --build index` is equivalent to the save button. While the process of setting up TiddlyWiki on Node.js is well documented and easy enough, the options for publishing such a wiki to an offline version (scriptably, e.g. for push-to-deploy setups) are decidedly non-obvious. With the added build steps, the user only needs to know three simple commands: tiddlywiki --init server tiddlywiki --server tiddlywiki --build index and optionally tiddlywiki --build static
2016-04-03 19:22:11 +00:00
Example Debian v8.0: `sudo ln -s /usr/bin/nodejs /usr/bin/node`
Doc: Adding comment to release notes re archived releases (#2882) * Doc: Adding comment to release notes to indicate where archived releases can be found. * Adding note about node.js to Release tiddler and Installing on Node.js tiddler
2017-06-09 14:33:24 +00:00
You can also install prior versions like this:
> npm install -g tiddlywiki@5.1.13
Reference in New Issue Copy Permalink