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

# Documize for YunoHost

[![Integration level](https://dash.yunohost.org/integration/documize.svg)](https://dash.yunohost.org/appci/app/documize) ![Working status](https://ci-apps.yunohost.org/ci/badges/documize.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/documize.maintain.svg)  
[![Install Documize with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=documize)

*[Lire ce readme en français.](./README_fr.md)*

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

Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.

### Features

- Built for technical and non-technical users
- Designed to unify both customer-facing and internal documentation
- Organization through labels, spaces and categories

**Shipped version:** 5.4.2~ynh1

**Demo:** https://docs.documize.com/

## Screenshots

![Screenshot of Documize](./doc/screenshots/screenshot.png)

## Documentation and resources

* Official app website: <https://www.documize.com>
* Official admin documentation: <https://docs.documize.com>
* Upstream app code repository: <https://github.com/documize/community>
* YunoHost documentation for this app: <https://yunohost.org/app_documize>
* Report a bug: <https://github.com/YunoHost-Apps/documize_ynh/issues>

## Developer info

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

To try the testing branch, please proceed like that.

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

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