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) ![Working status](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![Maintenance status](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)

*[Read this README in other languages.](./ALL_README.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 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.)](https://github.com/hackmdio/codimd/issues/720)

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

**Shipped version:** 2.5.4~ynh1

## Screenshots

![Screenshot of CodiMD](./doc/screenshots/screenshot.png)

## 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 Store: <https://apps.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:

```bash
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			`<!--`
Auto-update READMEs 2024-06-18 08:45:51 +02:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
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			`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
Testing (#86) * cleaning (#77) * Update upgrade * 2.4.2 (#79) * 2.4.2 * Auto-update README Co-authored-by: yunohost-bot <yunohost@yunohost.org> * [autopatch] Add Common Platform Enumeration id to `manifest.json` (#81) * Testing (#80) * cleaning (#77) * Update upgrade * 2.4.2 (#79) * 2.4.2 * Auto-update README Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: yunohost-bot <yunohost@yunohost.org> * [autopatch] Add Common Platform Enumeration id to `manifest.json` Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> * set relative path for --keep opt * Auto-update README * Update install * Auto-update README * Upgrade auto-updater (#84) * [autopatch] Upgrade auto-updater * Auto-update README --------- Co-authored-by: tituspijean <titus@pijean.ovh> * Update manifest.json * v2 (#85) * v2 * v2 * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.toml * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com> Co-authored-by: tituspijean <titus@pijean.ovh> 2023-04-27 18:37:24 +02:00			`[![Integration level](https://dash.yunohost.org/integration/codimd.svg)](https://dash.yunohost.org/appci/app/codimd) ![Working status](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![Maintenance status](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
Auto-update READMEs 2024-06-18 08:45:51 +02:00			`[Read this README in other languages.](./ALL_README.md)`
fix 2020-05-21 12:49:24 +02:00
Auto-update READMEs 2024-06-18 08:45:51 +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
Auto-update README 2021-09-04 11:37:46 +02:00			`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.)](https://github.com/hackmdio/codimd/issues/720)`

			`CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases.`
first 2018-11-21 16:11:09 +01:00
Auto-update READMEs 2024-06-18 08:45:51 +02:00			`Shipped version: 2.5.4~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
Auto-update README 2022-05-28 00:16:41 +02:00			`![Screenshot of CodiMD](./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			`## Documentation and resources`
fix 2020-05-21 12:49:24 +02:00
Auto-update READMEs 2024-06-18 08:45:51 +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 Store: <https://apps.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
Auto-update READMEs 2024-06-18 08:45:51 +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
Auto-update READMEs 2024-06-18 08:45:51 +02:00			To try the `testing` branch, please proceed like that:
Auto-update README 2022-05-28 00:16:41 +02:00
Auto-update READMEs 2024-06-18 08:45:51 +02:00			```bash
fix 2020-05-21 12:49:24 +02:00			`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
Auto-update README 2022-05-28 00:16:41 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`