codimd_ynh/README.md

# 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
CodiMD is a real-time collaborative word processing web service. It uses Markdown language.

**Shipped version:** 2.3.2

## Screenshots

![](https://raw.githubusercontent.com/hackmdio/codimd/develop/public/screenshot.png)

## Demo

* [Official demo]()

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

 * Official documentation: https://hackmd.io/c/codimd-documentation
 * YunoHost documentation: https://yunohost.org/en/app_codimd

## YunoHost specific features

#### Multi-user support

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

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/codimd.svg)](https://ci-apps-arm.yunohost.org/ci/apps/codimd/)

## Links

 * Report a bug: https://github.com/YunoHost-Apps/codimd_ynh/issues
 * Upstream app repository: https://github.com/hackmdio/codimd
 * YunoHost website: https://yunohost.org/

---

## 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
```
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)`

Revert #54 2020-11-22 16:49:21 +01:00			`> *This package allows you to install CodiMD quickly and simply on a YunoHost server.`
upgrade to original codiMD repo 2021-05-08 10:53:13 +02:00			`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`
Revert #54 2020-11-22 16:49:21 +01:00			`CodiMD is a real-time collaborative word processing web service. It uses Markdown language.`
Update README.md 2019-11-28 02:12:47 +01:00
upgrade to original codiMD repo 2021-05-08 10:53:13 +02:00			`Shipped version: 2.3.2`
Update README.md 2019-03-13 16:52:51 +01:00
fix 2020-05-21 12:49:24 +02:00			`## Screenshots`
Add more state of the app information 2019-11-28 18:06:39 +01:00
Fix 2021-05-08 11:06:29 +02:00			`![](https://raw.githubusercontent.com/hackmdio/codimd/develop/public/screenshot.png)`
Add more state of the app information 2019-11-28 18:06:39 +01:00
fix 2020-05-21 12:49:24 +02:00			`## Demo`
first 2018-11-21 16:11:09 +01:00
Fix 2021-05-08 11:23:20 +02:00			`* [Official demo]()`
first 2018-11-21 16:11:09 +01:00
fix 2020-05-21 12:49:24 +02:00			`## Configuration`
first 2018-11-21 16:11:09 +01:00
Fix 2021-05-08 11:06:29 +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)
first 2018-11-21 16:11:09 +01:00
fix 2020-05-21 12:49:24 +02:00			`## Documentation`

Fix 2021-05-08 11:06:29 +02:00			`* Official documentation: https://hackmd.io/c/codimd-documentation`
upgrade to original codiMD repo 2021-05-08 10:53:13 +02:00			`* YunoHost documentation: https://yunohost.org/en/app_codimd`
fix 2020-05-21 12:49:24 +02:00
			`## YunoHost specific features`

Apply last example_ynh (#1) * Apply last example_ynh * fix db_user * Fix service start 2020-06-13 16:12:37 +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
			`#### Supported architectures`

Fix 2021-05-08 11:23:20 +02:00			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/)`
			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/codimd.svg)](https://ci-apps-arm.yunohost.org/ci/apps/codimd/)`
fix 2020-05-21 12:49:24 +02:00
			`## Links`

			`* Report a bug: https://github.com/YunoHost-Apps/codimd_ynh/issues`
upgrade to original codiMD repo 2021-05-08 10:53:13 +02:00			`* Upstream app repository: https://github.com/hackmdio/codimd`
fix 2020-05-21 12:49:24 +02:00			`* YunoHost website: https://yunohost.org/`

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