mirror of https://github.com/YunoHost-Apps/codimd_ynh.git synced 2024-09-03 18:16:32 +02:00

CodiMD package for YunoHost

Find a file

lapineige 7352622c60 fix typo (spacing)		2020-11-22 14:28:03 +01:00
conf	Fix shasum due to name change	2020-11-15 14:11:53 +01:00
scripts	default -> example	2020-10-13 20:49:08 +02:00
check_process	rebase	2020-07-01 21:08:21 +02:00
issue_template.md	Minor typos	2020-10-12 22:05:07 +02:00
LICENSE	Initial commit	2018-11-21 16:00:57 +01:00
manifest.json	Transition to HedgeDoc	2020-11-15 16:33:24 +01:00
pull_request_template.md	add pull request template	2020-05-22 10:35:03 +02:00
README.md	fix typo (spacing)	2020-11-22 14:28:03 +01:00
README_fr.md	Transition Readme to HedgeDoc	2020-11-22 14:25:10 +01:00

README.md

HedgeDoc for YunoHost (formely CodiMD)

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 is a real-time collaborative word processing web service. It uses Markdown language.

Note: This package install HedgeDoc, which was formely called CodiMD, and not what's now called CodiMD (the open source part of HackMD). See https://hedgedoc.org/history/

Shipped version: 1.6.0

Screenshots

Demo

Official demo

Configuration

You can configure HedgeDoc by editing this file /var/www/codimd/config.json using the documentation

Documentation

Official documentation: https://github.com/hedgedoc/hedgedoc/tree/master/docs
YunoHost documentation: https://yunohost.org/#/app_codimd

YunoHost specific features

Multi-user support

Is LDAP supported? Yes
Can the app be used by multiple users? Yes

Supported architectures

x86-64 -
ARMv8-A -

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/codimd_ynh/tree/testing --debug
or
sudo yunohost app upgrade codimd -u https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug