lionwiki-t2t_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.
-->

# Lionwiki for YunoHost

[![Integration level](https://dash.yunohost.org/integration/lionwiki-t2t.svg)](https://ci-apps.yunohost.org/ci/apps/lionwiki-t2t/) ![Working status](https://ci-apps.yunohost.org/ci/badges/lionwiki-t2t.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/lionwiki-t2t.maintain.svg)

[![Install Lionwiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=lionwiki-t2t)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install Lionwiki 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

LionWiki-t2t is a minimalist Wiki engine programmed in PHP. It is extensible, templatable, file based (it doesn't need database like MySQL) and requires just one file to function (30 kb). It is suitable for small websites, personal notebooks or journals. This version is using the lightweight markup language TXT2TAGS.


**Shipped version:** 2024.08.28~ynh1

## Screenshots

![Screenshot of Lionwiki](./doc/screenshots/screenshot_lionwikit2t.png)

## Documentation and resources

- Official app website: <https://lionwiki-t2t.sourceforge.io/>
- Official user documentation: <https://github.com/farvardin/whatistxt2tags>
- Official admin documentation: <https://lionwiki-t2t.sourceforge.io/>
- Upstream app code repository: <https://sourceforge.net/projects/lionwiki-t2t>
- YunoHost Store: <https://apps.yunohost.org/app/lionwiki-t2t>
- Report a bug: <https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
or
sudo yunohost app upgrade lionwiki-t2t -u https://github.com/YunoHost-Apps/lionwiki-t2t_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>