1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/documize_ynh.git synced 2024-09-03 18:26:19 +02:00
documize_ynh/README.md

55 lines
2.1 KiB
Markdown
Raw Normal View History

2022-06-12 14:28:37 +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.
-->
2022-06-12 14:28:42 +02:00
# Documize for YunoHost
2022-06-12 14:28:37 +02:00
2023-02-07 08:16:20 +01:00
[![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)
2022-06-12 14:28:42 +02:00
[![Install Documize with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=documize)
2022-06-12 14:28:37 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2022-06-12 14:28:42 +02:00
> *This package allows you to install Documize quickly and simply on a YunoHost server.
2022-06-12 14:28:37 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2022-06-12 14:28:42 +02:00
Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.
2022-06-12 14:28:37 +02:00
### Features
2022-06-12 14:28:42 +02:00
- Built for technical and non-technical users
- Designed to unify both customer-facing and internal documentation
- Organization through labels, spaces and categories
2022-06-12 14:28:37 +02:00
2023-02-07 08:16:20 +01:00
**Shipped version:** 5.5.0~ynh1
2022-08-14 15:35:37 +02:00
2022-06-12 15:09:15 +02:00
**Demo:** https://docs.documize.com/
2022-06-12 14:28:37 +02:00
## Screenshots
2022-06-12 14:28:42 +02:00
![Screenshot of Documize](./doc/screenshots/screenshot.png)
2022-06-12 14:28:37 +02:00
## Documentation and resources
2022-06-12 14:28:42 +02:00
* 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>
2022-06-12 14:28:37 +02:00
## Developer info
2022-06-12 14:28:42 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/documize_ynh/tree/testing).
2022-06-12 14:28:37 +02:00
To try the testing branch, please proceed like that.
``` bash
2022-06-12 14:28:42 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
2022-06-12 14:28:37 +02:00
or
2022-06-12 14:28:42 +02:00
sudo yunohost app upgrade documize -u https://github.com/YunoHost-Apps/documize_ynh/tree/testing --debug
2022-06-12 14:28:37 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>