2021-06-19 16:49:27 +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.
-->
2020-11-19 21:41:03 +01:00
# HedgeDoc for YunoHost
2023-02-20 09:33:56 +01:00
[](https://dash.yunohost.org/appci/app/hedgedoc)  
2020-12-19 11:00:54 +01:00
[](https://install-app.yunohost.org/?app=hedgedoc)
2020-11-19 21:41:03 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-06-19 16:49:27 +02:00
> *This package allows you to install HedgeDoc 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.*
2020-11-19 21:41:03 +01:00
## Overview
2022-07-12 08:03:31 +02:00
HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor.
2020-11-19 21:41:03 +01:00
2022-07-12 08:03:31 +02:00
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’
### Features
- Real-time collaboration
- Graphs & diagrams
- Revisions
- Presentation mode
- Easy to use permission system
- Low system requirements
2023-07-01 14:22:40 +02:00
**Shipped version:** 1.9.8~ynh2
2020-11-19 21:41:03 +01:00
2021-06-19 16:49:27 +02:00
**Demo:** https://demo.hedgedoc.org/
## Screenshots
2020-11-19 21:41:03 +01:00
2022-07-12 08:03:31 +02:00
2020-11-19 21:41:03 +01:00
2021-06-19 16:49:27 +02:00
## Documentation and resources
2020-11-19 21:41:03 +01:00
2022-07-12 08:03:31 +02:00
* Official app website: < https: // hedgedoc . org >
* Official admin documentation: < https: // docs . hedgedoc . org />
* Upstream app code repository: < https: // github . com / hedgedoc / hedgedoc >
* YunoHost documentation for this app: < https: // yunohost . org / app_hedgedoc >
* Report a bug: < https: // github . com / YunoHost-Apps / hedgedoc_ynh / issues >
2020-11-19 21:41:03 +01:00
## Developer info
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.
2022-07-12 08:03:31 +02:00
``` bash
2020-11-19 21:41:03 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
or
sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug
```
2021-06-19 16:49:27 +02:00
2022-07-12 08:03:31 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >
