Provide guidance how to run the docs locally

tomkerkhove · Mar 26, 2019 · 39ff7b2 · 39ff7b2
1 parent 2c72d10
commit 39ff7b2
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,10 @@
 # Documenation for Promitor
 
 Contains all the documentation for [promitor.io](https://promitor.io)
+
+## Running the documentation locally
+You can easily run the documentation locally by using [Jkyll](https://jekyllrb.com/docs/):
+```shell
+⚡ tkerkhove@tomkerkhove C:\promitor
+❯  bundle exec jekyll serve
+```