We welcome contributions to the code and documentation of TiddlyWiki in several ways:
There are other ways to help TiddlyWiki too.
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
eg: Jeremy Ruston, @Jermolene, 2011/11/22
The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity". +
We welcome contributions to the code and documentation of TiddlyWiki in several ways:
There are other ways to help TiddlyWiki too.
Like other OpenSource projects, TiddlyWiki5 needs a signed contributor license agreement from individual contributors. This is a legal agreement that allows contributors to assert that they own the copyright of their contribution, and that they agree to license it to the UnaMesa Association (the legal entity that owns TiddlyWiki on behalf of the community).
Create a GitHub pull request to add your name to cla-individual.md or cla-entity.md, with the date in the format (YYYY/MM/DD).
step by step
cla-individual.md or cla-entity.md click icon on the top-right corner (clicking this button will fork the project so you can edit the file)eg: Jeremy Ruston, @Jermolene, 2011/11/22
The CLA documents used for this project were created using Harmony Project Templates. "HA-CLA-I-LIST Version 1.0" for "CLA-individual" and "HA-CLA-E-LIST Version 1.0" for "CLA-entity".
This file was automatically generated by TiddlyWiki5
\ No newline at end of file diff --git a/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid new file mode 100644 index 000000000..5d98ef3e4 --- /dev/null +++ b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid @@ -0,0 +1,20 @@ +title: Releasing a new version of TiddlyWiki + +# Adjust the release date of the latest release tiddler (eg, [[Release 5.1.3]]) +# Ensure [[Releases]] has the new version as the default tab +# Adjust the modified time of HelloThere +# Make sure ''Jermolene/TiddlyWiki5'' is fully committed +# Edit `package.json` to the new version number +# Run `bin/makereadmes.sh` to build the readme files +# Restore `package.json` to the previous version number +# Run `bin/verbump "5.1.3"` (substituting the correct version number) to update the version number and assign it a tag +# Run `npm publish` to publish to npm +# Verify that the new release of TiddlyWiki is available at https://www.npmjs.org/package/tiddlywiki +# Check the version number of TiddlyWiki specified in `package.json` +# Change current directory to the `build.jermolene.github.io` directory +# Run `npm install` to install the correct version of TiddlyWiki +# Change current directory to the `TiddlyWiki5` directory +# Run `../build.jermolene.github.io/bld.sh` to build the content files +# Verify that the files in the `jermolene.github.io` directory are correct +# Run `../build.jermolene.github.io/deploy.sh` to push the new files to GitHub +# Run `bin/wbld.shWelcome 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/
Developer documentation is in progress at http://tiddlywiki.com/dev/
npm install -g tiddlywikiIf 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)
tiddlywiki --version
5.0.8-beta; you may also see other debugging information reported)tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related componentstiddlywiki mynewwiki --server to start TiddlyWikiThe -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
-
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.htmlRunning 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:
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.htmlRunning 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:
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 tiddlywikiOn Mac or Linux you'll need to add sudo like this:
sudo npm update -g tiddlywikiIf 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 tiddlywikiOn Mac or Linux you'll need to add sudo like this:
sudo npm update -g tiddlywiki