2021-05-29 11:24:41 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2021-02-16 13:38:59 +01:00
# TiddlyWiki for YunoHost
[](https://dash.yunohost.org/appci/app/tiddlywiki)  
[](https://install-app.yunohost.org/?app=tiddlywiki)
*[Lire ce readme en français.](./README_fr.md)*
2021-05-29 11:24:41 +02:00
> *This package allows you to install TiddlyWiki quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2021-02-16 13:38:59 +01:00
## Overview
2021-09-03 12:30:22 +02:00
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.
2021-02-16 13:38:59 +01:00
2021-08-24 09:37:57 +02:00
**Shipped version:** 5.1.23~ynh5
2021-02-16 13:38:59 +01:00
2021-05-29 11:24:41 +02:00
**Demo:** https://tiddlywiki.com/
2021-02-16 16:06:44 +01:00
2021-05-29 11:24:41 +02:00
## Screenshots
2021-02-16 13:38:59 +01:00
2021-05-29 11:24:41 +02:00
2021-02-16 13:38:59 +01:00
2021-10-06 08:48:06 +02:00
## Disclaimers / important information
## Save your Tiddlers!
It is very important that you regularly backup your notes (tiddlers) locally.
- Click on the cloud icon -> `Save snapshot for offline use`
To restore a local backup to the server, drag and drop your tiddlers backup file into your TiddlyWiki page.
2021-05-29 11:24:41 +02:00
## Documentation and resources
2021-02-16 13:38:59 +01:00
2021-05-29 11:24:41 +02:00
* Official app website: https://tiddlywiki.com/
* Official admin documentation: https://tiddlywiki.com/
2021-06-24 18:54:13 +02:00
* Upstream app code repository: https://github.com/Jermolene/TiddlyWiki5
2021-05-29 11:24:41 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_tiddlywiki
* Report a bug: https://github.com/YunoHost-Apps/tiddlywiki_ynh/issues
2021-02-16 13:38:59 +01:00
2021-05-29 11:24:41 +02:00
## Developer info
2021-02-16 13:38:59 +01:00
2021-05-29 11:24:41 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/tiddlywiki_ynh/tree/testing ).
2021-02-16 13:38:59 +01:00
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/tiddlywiki_ynh/tree/testing --debug
or
sudo yunohost app upgrade tiddlywiki -u https://github.com/YunoHost-Apps/tiddlywiki_ynh/tree/testing --debug
```
2021-05-29 11:24:41 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps
