mirror of
https://github.com/YunoHost-Apps/hedgedoc_ynh.git
synced 2024-09-03 19:25:52 +02:00
67 lines
2.6 KiB
Markdown
67 lines
2.6 KiB
Markdown
<!--
|
||
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 for YunoHost
|
||
|
||
[](https://dash.yunohost.org/appci/app/hedgedoc)  
|
||
[](https://install-app.yunohost.org/?app=hedgedoc)
|
||
|
||
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
||
> *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.*
|
||
|
||
## Overview
|
||
|
||
HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor.
|
||
|
||
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/
|
||
|
||
## Screenshots
|
||
|
||
|
||
|
||
## Disclaimers / important information
|
||
|
||
## Configuration
|
||
|
||
You can configure HedgeDoc by editing this file `/var/www/hedgedoc/config.json` using the [documentation](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md)
|
||
When you finished editing the configuration, for your changes to take effect, you will have to run: `sudo systemctl restart hedgedoc`.
|
||
|
||
## Documentation and resources
|
||
|
||
* 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>
|
||
|
||
## 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.
|
||
|
||
``` bash
|
||
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
|
||
```
|
||
|
||
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|