# TiddlyWiki for YunoHost [![Integration level](https://dash.yunohost.org/integration/tiddlywiki.svg)](https://dash.yunohost.org/appci/app/tiddlywiki) ![](https://ci-apps.yunohost.org/ci/badges/tiddlywiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/tiddlywiki.maintain.svg) [![Install TiddlyWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=tiddlywiki) *[Lire ce readme en français.](./README_fr.md)* > *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.* ## Overview 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. **Shipped version:** 5.2.2~ynh1 **Demo:** https://tiddlywiki.com/ ## Screenshots ![](./doc/screenshots/.DS_Store) ![](./doc/screenshots/screenshot.png) ## 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. ## Documentation and resources * Official app website: https://tiddlywiki.com/ * Official admin documentation: https://tiddlywiki.com/ * Upstream app code repository: https://github.com/Jermolene/TiddlyWiki5 * YunoHost documentation for this app: https://yunohost.org/app_tiddlywiki * Report a bug: https://github.com/YunoHost-Apps/tiddlywiki_ynh/issues ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/tiddlywiki_ynh/tree/testing). 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 ``` **More info regarding app packaging:** https://yunohost.org/packaging_apps