mirror of
https://github.com/YunoHost-Apps/codimd_ynh.git
synced 2024-09-03 18:16:32 +02:00
0587b4321d
* Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates
59 lines
No EOL
2.2 KiB
Markdown
59 lines
No EOL
2.2 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# CodiMD for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/codimd)  
|
|
[](https://install-app.yunohost.org/?app=codimd)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install CodiMD quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) 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](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-configuration)
|
|
|
|
## 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](https://github.com/YunoHost-Apps/codimd_ynh/tree/testing).
|
|
|
|
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 |