diff options
| author | Claudius | 2019-03-31 20:10:32 +0200 |
|---|---|---|
| committer | Claudius | 2019-04-01 01:03:36 +0200 |
| commit | 54edec89000aec94cae325be3d5c85442ac21adf (patch) | |
| tree | 700b588b4a5d3682ff6fdb36ea0f4281bbf8d82d /docs/setup | |
| parent | 74fdd26ea057dab77e761614497d69d2c90a66d7 (diff) | |
striving for consistency across various docs
Signed-off-by: Claudius <opensource@amenthes.de>
Diffstat (limited to 'docs/setup')
| -rw-r--r-- | docs/setup/cloudron.md | 3 | ||||
| -rw-r--r-- | docs/setup/docker.md | 7 | ||||
| -rw-r--r-- | docs/setup/heroku.md | 3 | ||||
| -rw-r--r-- | docs/setup/kubernetes.md | 3 | ||||
| -rw-r--r-- | docs/setup/manual-setup.md | 4 |
5 files changed, 13 insertions, 7 deletions
diff --git a/docs/setup/cloudron.md b/docs/setup/cloudron.md index edab7d0d..aa707dc4 100644 --- a/docs/setup/cloudron.md +++ b/docs/setup/cloudron.md @@ -1,4 +1,5 @@ -## Cloudron +Cloudron +=== Install CodiMD on [Cloudron](https://cloudron.io): diff --git a/docs/setup/docker.md b/docs/setup/docker.md index defe467a..1a9fd89f 100644 --- a/docs/setup/docker.md +++ b/docs/setup/docker.md @@ -1,5 +1,6 @@ +CodiMD by docker container +=== -## CodiMD by docker container [](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). diff --git a/docs/setup/heroku.md b/docs/setup/heroku.md index 86b4ecae..9dc3bb3a 100644 --- a/docs/setup/heroku.md +++ b/docs/setup/heroku.md @@ -1,4 +1,5 @@ -## Heroku Deployment +Heroku Deployment +=== You can quickly setup a sample Heroku CodiMD application by clicking the button below. diff --git a/docs/setup/kubernetes.md b/docs/setup/kubernetes.md index 400e2b4f..db596851 100644 --- a/docs/setup/kubernetes.md +++ b/docs/setup/kubernetes.md @@ -1,4 +1,5 @@ -## Kubernetes +Kubernetes +=== To install use `helm install stable/hackmd`. diff --git a/docs/setup/manual-setup.md b/docs/setup/manual-setup.md index 25869ee0..721d5bf7 100644 --- a/docs/setup/manual-setup.md +++ b/docs/setup/manual-setup.md @@ -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 |