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

Éric Gaspar cd70816833 Testing (#61 ) * Update config.json.example * Cleaning up		2021-06-21 15:15:03 +02:00
.github	Level 7 (#59 )	2021-06-21 11:14:57 +02:00
conf	Testing (#61 )	2021-06-21 15:15:03 +02:00
doc	Fix	2021-06-21 12:00:29 +02:00
scripts	Testing (#61 )	2021-06-21 15:15:03 +02:00
check_process	fix	2021-06-21 11:47:33 +02:00
LICENSE	Initial commit	2018-11-21 16:00:57 +01:00
manifest.json	fix	2021-06-21 11:47:33 +02:00
README.md	Level 7 (#59 )	2021-06-21 11:14:57 +02:00
README_fr.md	Auto-update README	2021-06-21 11:16:19 +00:00

README.md

CodiMD for YunoHost

Lire ce readme en français.

This package allows you to install CodiMD quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Collaborative editor to work on notes written in Markdown

Shipped version: 2.4.1~ynh1

Screenshots

Disclaimers / important information

Multi-user support

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

Configuration

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

Documentation and resources

Official app website: https://hackmd.io/
Official user documentation: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#User-Guides
Official admin documentation: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-documentation#Administration-Guides
Upstream app code repository: https://github.com/hackmdio/codimd
YunoHost documentation for this app: https://yunohost.org/app_codimd
Report a bug: https://github.com/YunoHost-Apps/codimd_ynh/issues

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

More info regarding app packaging: https://yunohost.org/packaging_apps