codimd_ynh/README.md

<!--
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

[![Integration level](https://dash.yunohost.org/integration/codimd.svg)](https://dash.yunohost.org/appci/app/codimd) ![](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/codimd.maintain.svg)  
[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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

![](./doc/screenshots/screenshot.png)

## 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
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`<!--`
			`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.`
			`-->`

Revert #54 2020-11-22 16:49:21 +01:00			`# CodiMD for YunoHost`
first 2018-11-21 16:11:09 +01:00
fix 2020-05-21 12:49:24 +02:00			`[![Integration level](https://dash.yunohost.org/integration/codimd.svg)](https://dash.yunohost.org/appci/app/codimd) ![](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/codimd.maintain.svg)`
Set badge to SVG 2020-12-19 13:50:12 +01:00			`[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=codimd)`
fix 2020-05-21 12:49:24 +02:00
			`[Lire ce readme en français.](./README_fr.md)`

Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`> *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.*`
fix 2020-05-21 12:49:24 +02:00
			`## Overview`
Add more state of the app information 2019-11-28 18:06:39 +01:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`Collaborative editor to work on notes written in Markdown`
first 2018-11-21 16:11:09 +01:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`Shipped version: 2.4.1~ynh1`
first 2018-11-21 16:11:09 +01:00


Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`## Screenshots`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`![](./doc/screenshots/screenshot.png)`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`## Disclaimers / important information`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`### Multi-user support`
fix 2020-05-21 12:49:24 +02:00
Improve descriptions 2020-06-03 09:43:47 +02:00			`* Is LDAP supported? Yes`
			`* Can the app be used by multiple users? Yes`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`### Configuration`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			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)
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`## Documentation and resources`
fix 2020-05-21 12:49:24 +02:00
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00			`* 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`
first 2018-11-21 16:11:09 +01:00
Minor typos 2020-10-12 22:05:07 +02:00			`## Developer info`
Add advanced configuration documentation 2020-05-06 11:05:04 +02:00
Apply last example_ynh (#1) * Apply last example_ynh * fix db_user * Fix service start 2020-06-13 16:12:37 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/codimd_ynh/tree/testing).`
first 2018-11-21 16:11:09 +01:00
fix 2020-05-21 12:49:24 +02:00			`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`
			```
Level 7 (#59) * Fix systemd unit * Fix linter __ENV_PATH__ is not used anymore * Auto-generated README * Fix change_url * Update GitHub templates 2021-06-21 11:14:57 +02:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`