Merge pull request #12 from hellofresh/readthedocs

boekkooi-fresh · web-flow · commit 3cf3ece71283 · 2019-02-19T16:06:36.000+01:00
Add Read the Docs configuration
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,6 @@
+# GoEngine
+
+GoEngine is an Event Sourcing library written for GoLang.
+
+The goal of this library is to reduce the amount of time you have to spend thinking about the infrastructure so you can focus on  
+implementing your Domains and Business logic!
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+mkdocs==1.0.4
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: GoEngine
+docs_dir: docs
+repo_url: https://github.com/hellofresh/goengine
+copyright: Copyright (c) 2019 HelloFresh
+theme:
+  name: readthedocs
+  highlightjs: true
+  hljs_languages:
+    - golang
+nav:
+  - Home: README.md
+  - Quick Start: quick-start.md
+  - Extensions:
+      - Overview: extension/README.md
+      - Database: extension/database.md
+      - Logging: extension/logging.md
