Merge pull request #410 from oupala/feature/markdown-linting

docs/setup/cloudron.md

@@ -1,5 +1,4 @@
-Cloudron
-===
+# Cloudron
 
 CodiMD is available as a 1-click install on [Cloudron](https://cloudron.io).  Cloudron makes it easy to run apps like CodiMD on your server and keep them up-to-date and secure.
 

docs/setup/docker-linuxserver.md

@@ -1,13 +1,11 @@
-LinuxServer.io CodiMD Image
-===
+# LinuxServer.io CodiMD Image
+
 [![LinuxServer.io Discord](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)[![container version badge](https://images.microbadger.com/badges/version/linuxserver/codimd.svg)](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")[![container image size badge](https://images.microbadger.com/badges/image/linuxserver/codimd.svg)](https://microbadger.com/images/linuxserver/codimd "Get your own version badge on microbadger.com")![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codimd.svg)![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codimd.svg)[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-codimd/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/)[![LinuxServer.io CI summary](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html)
 
 [LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf which supports PDF export from all architectures using [PhantomJS](https://phantomjs.org/).
 
 - It supports all the environment variables detailed in the [configuration documentation](../configuration-env-vars.md) to modify it according to your needs.
-
 - It gets rebuilt on new releases from CodiMD and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your CodiMD instance up to date.
-
 - It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-codimd/#application-setup) CodiMD using their [LetsEncrypt docker image](https://github.com/linuxserver/docker-letsencrypt)
 
 In order to contribute check the LinuxServer.io [GitHub repository](https://github.com/linuxserver/docker-codimd/) for CodiMD.

docs/setup/docker.md

@@ -1,15 +1,12 @@
-CodiMD Docker Image
-===
+# CodiMD Docker Image
 
 [![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)
 
-
-**Debian-based version:**
+## Debian-based version
 
 [![Docker Repository on Quay](https://quay.io/repository/codimd/server/status "Docker Repository on Quay")](https://quay.io/repository/codimd/server)
 
-
-**Alpine-based version:**
+## Alpine-based version
 
 [![Docker Repository on Quay](https://quay.io/repository/codimd/server/status "Docker Repository on Quay")](https://quay.io/repository/codimd/server)
 

docs/setup/heroku.md

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

docs/setup/kubernetes.md

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

docs/setup/manual-setup.md

@@ -1,33 +1,42 @@
-Manual Installation
-===
+# Manual Installation
 
 ## Requirements on your server
 
 - Node.js 8.5 or up
+
 - Database (PostgreSQL, MySQL, MariaDB, SQLite, MSSQL). Must use charset `utf8`: this is typically the
   default in PostgreSQL and SQLite, while in MySQL and MariaDB utf8 might need to be set with
   `alter database <DBNAME> character set utf8 collate utf8_bin;`
-- npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
-- yarn
-- Bash (for the setup script)
-- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
 
+- npm (and its dependencies, [node-gyp](https://github.com/nodejs/node-gyp#installation))
+
+- yarn
+
+- Bash (for the setup script)
+
+- For **building** CodiMD we recommend to use a machine with at least **2GB** RAM
 
 ## Instructions
 
 1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
+
 2. Clone this repository (preferred) or download a release and unzip it.
+
 3. Enter the directory and type `bin/setup`, which will install npm dependencies and create configs.
+
 4. Modify `config.json` or configure CodiMD through environment variables which will
    overwrite the configs, see docs [here](https://github.com/codimd/server/blob/master/docs/configuration.md).
+
 5. Build front-end bundle by `yarn run build` (use `yarn run dev` if you are in development)
+
 6. Modify the file named `.sequelizerc`, change the value of the variable `url` with your db connection string. For example:
    - `postgres://username:password@localhost:5432/codimd`
    - `mysql://username:password@localhost:3306/codimd`
    - `sqlite://:memory:`
-7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
-8. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
 
+7. It is recommended to start your server manually once: `npm start --production`, this way it's easier to see warnings or errors that might occur (leave out `--production` for development).
+
+8. Run the server as you like (node, forever, pm2, SystemD, Init-Scripts)
 
 ## How to upgrade your installation