YunoHost-Apps/hedgedoc_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/hedgedoc_ynh.git synced 2024-09-03 19:25:52 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2022-07-10 21:16:19 +00:00
parent bc18fc231e
commit 48e19aef9b
2 changed files with 51 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -5,7 +5,7 @@ It shall NOT be edited by hand.
# HedgeDoc for YunoHost # HedgeDoc for YunoHost
[![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Working status](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)
[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) [![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
@ -15,15 +15,26 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview ## Overview
Collaborative editor to work on notes written in Markdown HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor.
**Shipped version:** 1.9.3~ynh1 You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go.
### Features
- Real-time collaboration
- Graphs & diagrams
- Revisions
- Presentation mode
- Easy to use permission system
- Low system requirements
**Shipped version:** 1.9.4~ynh1
**Demo:** https://demo.hedgedoc.org/ **Demo:** https://demo.hedgedoc.org/
## Screenshots ## Screenshots
![](./doc/screenshots/screenshot.png) ![Screenshot of HedgeDoc](./doc/screenshots/screenshot.png)
## Disclaimers / important information ## Disclaimers / important information
@ -34,21 +45,22 @@ When you finished editing the configuration, for your changes to take effect, yo
## Documentation and resources ## Documentation and resources
* Official app website: https://hedgedoc.org * Official app website: <https://hedgedoc.org>
* Official admin documentation: https://docs.hedgedoc.org/ * Official admin documentation: <https://docs.hedgedoc.org/>
* Upstream app code repository: https://github.com/hedgedoc/hedgedoc * Upstream app code repository: <https://github.com/hedgedoc/hedgedoc>
* YunoHost documentation for this app: https://yunohost.org/app_hedgedoc * YunoHost documentation for this app: <https://yunohost.org/app_hedgedoc>
* Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues * Report a bug: <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
or or
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** https://yunohost.org/packaging_apps **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

40
README_fr.md
View file

@ -1,25 +1,40 @@
<!--
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.
-->
# HedgeDoc pour YunoHost # HedgeDoc pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) [![Niveau d'intégration](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg)
[![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) [![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## Vue d'ensemble
Éditeur collaboratif pour travailler sur des notes en Markdown HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor.
**Version incluse :** 1.9.3~ynh1 You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go.
### Features
- Real-time collaboration
- Graphs & diagrams
- Revisions
- Presentation mode
- Easy to use permission system
- Low system requirements
**Version incluse :** 1.9.4~ynh1
**Démo :** https://demo.hedgedoc.org/ **Démo :** https://demo.hedgedoc.org/
## Captures d'écran ## Captures d'écran
![](./doc/screenshots/screenshot.png) ![Capture d'écran de HedgeDoc](./doc/screenshots/screenshot.png)
## Avertissements / informations importantes ## Avertissements / informations importantes
@ -30,21 +45,22 @@ Lorsque vous avez terminé de modifier la configuration, pour que vos modificati
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : https://hedgedoc.org * Site officiel de l'app : <https://hedgedoc.org>
* Documentation officielle de l'admin : https://docs.hedgedoc.org/ * Documentation officielle de l'admin : <https://docs.hedgedoc.org/>
* Dépôt de code officiel de l'app : https://github.com/hedgedoc/hedgedoc * Dépôt de code officiel de l'app : <https://github.com/hedgedoc/hedgedoc>
* Documentation YunoHost pour cette app : https://yunohost.org/app_hedgedoc * Documentation YunoHost pour cette app : <https://yunohost.org/app_hedgedoc>
* Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues * Signaler un bug : <https://github.com/YunoHost-Apps/hedgedoc_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
```
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps **Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>