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 0dddd79210 v2 (#85 ) * v2 * v2 * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org>		2023-04-27 11:08:37 +02:00
.github	v2 (#85 )	2023-04-27 11:08:37 +02:00
conf	v2 (#85 )	2023-04-27 11:08:37 +02:00
doc	v2 (#85 )	2023-04-27 11:08:37 +02:00
scripts	v2 (#85 )	2023-04-27 11:08:37 +02:00
LICENSE	Initial commit	2018-11-21 16:00:57 +01:00
manifest.toml	v2 (#85 )	2023-04-27 11:08:37 +02:00
README.md	v2 (#85 )	2023-04-27 11:08:37 +02:00
README_fr.md	v2 (#85 )	2023-04-27 11:08:37 +02:00
tests.toml	v2 (#85 )	2023-04-27 11:08:37 +02: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

CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data. (See the origin of the name CodiMD.)

CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases.

Shipped version: 2.4.2~ynh1

Screenshots

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