tiddlywiki_ynh/README.md

<!--
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.
-->

# 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.1.23~ynh5

**Demo:** https://tiddlywiki.com/

## Screenshots

![](./doc/screenshots/.DS_Store)
![](./doc/screenshots/screenshot.png)

## 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
Auto-update README 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.`
			`-->`

First commit 2021-02-16 13:38:59 +01:00			`# 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)`

Auto-update README 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.*`
First commit 2021-02-16 13:38:59 +01:00
			`## Overview`

Auto-update README 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.`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-08-24 09:37:57 +02:00			`Shipped version: 5.1.23~ynh5`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`Demo: https://tiddlywiki.com/`
Fix 2021-02-16 16:06:44 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`## Screenshots`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`![](./doc/screenshots/.DS_Store)`
			`![](./doc/screenshots/screenshot.png)`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`## Documentation and resources`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`* Official app website: https://tiddlywiki.com/`
			`* Official admin documentation: https://tiddlywiki.com/`
Auto-update README 2021-06-24 18:54:13 +02:00			`* Upstream app code repository: https://github.com/Jermolene/TiddlyWiki5`
Auto-update README 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`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 2021-05-29 11:24:41 +02:00			`## Developer info`
First commit 2021-02-16 13:38:59 +01:00
Auto-update README 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).`
First commit 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`
			```
Auto-update README 2021-05-29 11:24:41 +02:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`