TiddlyWiki5/readme.md

209 wiersze
11 KiB
Markdown
Czysty Zwykły widok Historia

2015-07-03 15:47:39 +00:00
<p>Welcome to <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a>, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.</p><p><a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> is a complete interactive wiki in <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/JavaScript.html">JavaScript</a>. 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 <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/WikiText.html">WikiText</a>.</p><p>Learn more and see it in action at <a class="tc-tiddlylink-external" href="http://tiddlywiki.com/" target="_blank">http://tiddlywiki.com/</a></p><p>Developer documentation is in progress at <a class="tc-tiddlylink-external" href="http://tiddlywiki.com/dev/" target="_blank">http://tiddlywiki.com/dev/</a></p><h1 class="">Installing <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><ol><li>Install <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Node.js.html">Node.js</a> from <a class="tc-tiddlylink-external" href="http://nodejs.org" target="_blank">http://nodejs.org</a></li><li>Open a command line terminal and type:<blockquote><p><code>npm install -g tiddlywiki</code></p><p>If it fails with an error you may need to re-run the command as an administrator:</p><p><code>sudo npm install -g tiddlywiki</code> (Mac/Linux)</p></blockquote></li><li>Check <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> is installed by typing:<blockquote><p><code>tiddlywiki --version</code></p></blockquote></li><li>In response, you should see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> report its current version (eg &quot;5.1.8&quot;; you may also see other debugging information reported)</li><li>Try it out:<ol><li><code>tiddlywiki mynewwiki --init server</code> to create a folder for a new wiki that includes server-related components</li><li><code>tiddlywiki mynewwiki --server</code> to start <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a></li><li>Visit <a class="tc-tiddlylink-external" href="http://127.0.0.1:8080/" target="_blank">http://127.0.0.1:8080/</a> in your browser</li><li>Try editing and creating tiddlers</li></ol></li></ol><p>The <code>-g</code> flag causes <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> to be installed globally. Without it, <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> will only be available in the directory where you installed it.</p><p>If you are using Debian or Debian-based Linux and you are reciving a <code>node: command not found</code> error though node.js package is installed, you may need to create a symbolic link between <code>nodejs</code> and <code>node</code>. Consult your distro's manual and <code>whereis</code> to correctly create a link. See github <a class="tc-tiddlylink-external" href="http://github.com/Jermolene/TiddlyWiki5/issues/1434" target="_blank">issue 1434</a></p><p>Example Debian v8.0: <code>sudo ln -s /usr/bin/nodejs /usr/bin/node</code></p><h1 class="">Using <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p><a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki5.html">TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com
2014-09-20 14:06:33 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/BuildCommand.html">
2014-10-22 15:58:15 +00:00
build
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/ClearPasswordCommand.html">
2014-10-22 15:58:15 +00:00
clearpassword
2014-09-20 14:06:33 +00:00
</a>
</li>
2014-11-26 16:08:55 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/EditionsCommand.html">
2014-11-26 16:08:55 +00:00
editions
</a>
</li>
2014-09-20 14:06:33 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/HelpCommand.html">
2014-10-22 15:58:15 +00:00
help
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/InitCommand.html">
2014-10-22 15:58:15 +00:00
init
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/LoadCommand.html">
2014-10-22 15:58:15 +00:00
load
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/MakeLibraryCommand.html">
2014-10-22 15:58:15 +00:00
makelibrary
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/OutputCommand.html">
2014-10-22 15:58:15 +00:00
output
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/PasswordCommand.html">
2014-10-22 15:58:15 +00:00
password
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/RenderTiddlerCommand.html">
2014-10-22 15:58:15 +00:00
rendertiddler
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/RenderTiddlersCommand.html">
2014-10-22 15:58:15 +00:00
rendertiddlers
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/SaveTiddlerCommand.html">
2014-10-22 15:58:15 +00:00
savetiddler
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/SaveTiddlersCommand.html">
2014-10-22 15:58:15 +00:00
savetiddlers
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/ServerCommand.html">
2014-10-22 15:58:15 +00:00
server
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/SetFieldCommand.html">
2014-10-22 15:58:15 +00:00
setfield
2014-09-20 14:06:33 +00:00
</a>
</li>
2014-11-26 16:08:55 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/UnpackPluginCommand.html">
2014-11-26 16:08:55 +00:00
unpackplugin
</a>
</li>
2014-09-20 14:06:33 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/VerboseCommand.html">
2014-10-22 15:58:15 +00:00
verbose
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/VersionCommand.html">
2014-10-22 15:58:15 +00:00
version
2014-09-20 14:06:33 +00:00
</a>
</li>
2015-07-03 15:47:39 +00:00
</ul></p><h1 class="">Upgrading <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a> on Node.js</h1><p>If you've installed <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html">TiddlyWiki on Node.js</a> on the usual way, when a new version is released you can upgrade it with this command:</p><pre><code>npm update -g tiddlywiki</code></pre><p>On Mac or Linux you'll need to add <strong>sudo</strong> like this:</p><pre><code>sudo npm update -g tiddlywiki</code></pre><h1 class="">Also see</h1><p><ul class="">
2014-09-20 14:06:33 +00:00
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWikiFolders.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
TiddlyWikiFolders
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/MultiTiddlerFileSyntax.html">
MultiTiddlerFileSyntax
</a>
</li>
<li>
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/MultiTiddlerFiles.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
MultiTiddlerFiles
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlerFiles.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
TiddlerFiles
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Generating%2520Static%2520Sites%2520with%2520TiddlyWiki.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Generating Static Sites with TiddlyWiki
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/How%2520to%2520build%2520a%2520TiddlyWiki5%2520from%2520individual%2520tiddlers.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
How to build a TiddlyWiki5 from individual tiddlers
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Using%2520TiddlyWiki%2520for%2520GitHub%2520project%2520documentation.html">
2014-10-22 15:58:15 +00:00
2014-10-20 17:06:18 +00:00
Using TiddlyWiki for GitHub project documentation
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with%2520the%2520client-server%2520edition.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Using a custom path prefix with the client-server edition
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Building%2520TiddlyWikiClassic.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Building TiddlyWikiClassic
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Environment%2520Variables%2520on%2520Node.js.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Environment Variables on Node.js
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Scripts%2520for%2520TiddlyWiki%2520on%2520Node.js.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Scripts for TiddlyWiki on Node.js
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
<li>
2015-07-03 15:47:39 +00:00
<a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/Working%2520with%2520the%2520TiddlyWiki5%2520repository.html">
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
Working with the TiddlyWiki5 repository
2014-10-22 15:58:15 +00:00
2014-09-20 14:06:33 +00:00
</a>
</li>
2015-07-03 15:47:39 +00:00
</ul></p><p><em>This readme file was automatically generated by <a class="tc-tiddlylink tc-tiddlylink-resolves" href="http://tiddlywiki.com/static/TiddlyWiki.html">TiddlyWiki</a></em></p>