striving for consistency across various docs

Signed-off-by: Claudius <opensource@amenthes.de>
This commit is contained in:
Claudius 2019-03-31 20:10:32 +02:00
parent 74fdd26ea0
commit 54edec8900
27 changed files with 175 additions and 171 deletions

View file

@ -1,4 +1,5 @@
## Cloudron
Cloudron
===
Install CodiMD on [Cloudron](https://cloudron.io):

View file

@ -1,5 +1,6 @@
CodiMD by docker container
===
## CodiMD by docker container
[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://github.com/codimd/container/raw/master/docker-compose.yml&stack_name=codimd)
@ -14,9 +15,9 @@
The easiest way to setup CodiMD using docker are using the following three commands:
```console
```sh
git clone https://github.com/codimd/container.git
cd codimd-container
docker-compose up
```
Read more about it in the [container repository](https://github.com/codimd/container)
Read more about it in the [container repository](https://github.com/codimd/container).

View file

@ -1,4 +1,5 @@
## Heroku Deployment
Heroku Deployment
===
You can quickly setup a sample Heroku CodiMD application by clicking the button
below.

View file

@ -1,4 +1,5 @@
## Kubernetes
Kubernetes
===
To install use `helm install stable/hackmd`.

View file

@ -1,4 +1,5 @@
# Manual Installation
Manual Installation
===
## Requirements on your server
@ -8,6 +9,7 @@
- `libssl-dev` for building scrypt (see [here](https://github.com/ml1nk/node-scrypt/blob/master/README.md#installation-instructions) for further information)
- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
## Instructions
1. Download a release and unzip or clone into a directory