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

ericgaspar 28d6e0d5cd move to postesql		2020-05-23 09:14:00 +02:00
conf	move to postesql	2020-05-23 09:14:00 +02:00
scripts	move to postesql	2020-05-23 09:14:00 +02:00
LICENSE	Initial commit	2018-11-21 16:00:57 +01:00
manifest.json	move to postesql	2020-05-23 09:14:00 +02:00
pull_request_template.md	add pull request template	2020-05-22 10:35:03 +02:00
README.md	update README	2020-05-22 10:35:30 +02:00
README_fr.md	update README	2020-05-22 10:35:30 +02:00

README.md

CodiMD for YunoHost

Lire ce readme en français.

This package allow you to install CodiMD quickly and simply on a YunoHost server.
If you don't have YunoHost, please see here to know how to install and enjoy it.

Overview

Collaborative editor to work on notes written in Markdown.

Shipped version: 1.6.0

Screenshots

Demo

Official demo

Configuration

If you need to configure CodiMD, you can tweak /var/www/codimd/config.json file using this documentation

Documentation

Official documentation: https://hackmd.io/c/codimd-documentation/
YunoHost documentation: If specific documentation is needed, feel free to contribute.

YunoHost specific features

Multi-users support

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

Supported architectures

x86-64b -
ARMv8-A -

Limitations

Status: In progress, do not consider this app as stable and fully working (yet)

Additional information

Developers info

Please do 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