docs: add mkdocs setup

Signed-off-by: Alex Marshall <alex@blockchaintp.com>
blockchaintp · Jul 28, 2021 · 525d75b · 525d75b
1 parent 5331ac8
commit 525d75b
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,6 @@
 build
 pom.xml.versionsBackup
 markers
+
+# MkDocs documentation
+site/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,9 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+mkdocs:
+  configuration: mkdocs.yml
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+# Daml on QLDB
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,4 @@
+site_name: Daml on QLDB
+site_author: BTP
+theme: readthedocs
+copyright: Copyright &copy; 2021 Blockchain Technology Partners
-Original file line number
+Diff line change
@@ Expand Up / @@ -37,3 +37,6 @@ @@
     build
     pom.xml.versionsBackup
     markers
+    # MkDocs documentation
+    site/