1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/hedgedoc_ynh.git synced 2024-09-03 19:25:52 +02:00
hedgedoc_ynh/README.md
2022-08-12 11:07:21 +00:00

2.6 KiB
Raw Blame History

HedgeDoc for YunoHost

Integration level Working status Maintenance status
Install HedgeDoc with YunoHost

Lire ce readme en français.

This package allows you to install HedgeDoc quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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 theyre 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

Screenshot of HedgeDoc

Disclaimers / important information

Configuration

You can configure HedgeDoc by editing this file /var/www/hedgedoc/config.json using the documentation
When you finished editing the configuration, for your changes to take effect, you will have to run: sudo systemctl restart hedgedoc.

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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