codimd_ynh/README.md

# CodiMD for YunoHost

A collaborative editor to work on notes written in Markdown

**Shipped version:** 1.6.0

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

**To be implemented**:
- Upgrade (right now you need to remove the app and install its new version - your documents are likely to be lost…)
- Backup and restore system

Links:
- [Yunohost project](https://yunohost.org)
- [CodiMD website](https://github.com/codimd/server/)
- [Demo](https://demo.codimd.org/)

[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd)


### Screenshot

![](https://demo.codimd.org/screenshot.png)

### Advanced configuration

If you need to configure your CodiMD, you can tweak your `config.json` file, using this documentation: https://github.com/codimd/server/blob/master/docs/configuration-config-file.md
Update README.md 2019-11-28 02:12:47 +01:00			`# CodiMD for YunoHost`
first 2018-11-21 16:11:09 +01:00
Update README.md 2019-11-28 02:12:47 +01:00			`A collaborative editor to work on notes written in Markdown`

Update CodiMD version to 1.6.0 2020-03-09 17:38:20 +01:00			`Shipped version: 1.6.0`
Update README.md 2019-03-13 16:52:51 +01:00
Add more state of the app information 2019-11-28 18:06:39 +01:00			`Status: In progress, do not consider this app as stable and fully working (yet)`

			`To be implemented:`
			`- Upgrade (right now you need to remove the app and install its new version - your documents are likely to be lost…)`
			`- Backup and restore system`

			`Links:`
first 2018-11-21 16:11:09 +01:00			`- [Yunohost project](https://yunohost.org)`
Repository has changed Hi, the repository for CodiMD has changed, the community project can now be found here: https://github.com/codimd/server If you wish to know more about this change, we've written a few things about it here: https://github.com/codimd/server/issues/10 2019-05-02 00:54:38 +02:00			`- [CodiMD website](https://github.com/codimd/server/)`
Update README.md 2019-11-28 02:12:47 +01:00			`- [Demo](https://demo.codimd.org/)`
first 2018-11-21 16:11:09 +01:00
			`[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd)`


Update README.md 2019-11-28 02:12:47 +01:00			`### Screenshot`
first 2018-11-21 16:11:09 +01:00
Update README.md 2019-11-28 02:12:47 +01:00			`![](https://demo.codimd.org/screenshot.png)`
first 2018-11-21 16:11:09 +01:00
Add advanced configuration documentation 2020-05-06 11:05:04 +02:00			`### Advanced configuration`

			If you need to configure your CodiMD, you can tweak your `config.json` file, using this documentation: https://github.com/codimd/server/blob/master/docs/configuration-config-file.md
first 2018-11-21 16:11:09 +01:00