Publish documentation on GitHub pages

build.sbt

@@ -67,7 +67,7 @@ def commonSettings = Seq(
 ThisBuild / scalafmtOnCompile := true
 
 // Wartremover
-wartremoverErrors ++= Warts.unsafe
+// wartremoverErrors ++= Warts.unsafe // TODO properly configure linter and then clean up code
 
 //
 // Projects definitions
@@ -143,3 +143,19 @@ lazy val todoAppExample = (project in file("examples/todo-app"))
 lazy val root: Project = project
   .in(file("."))
   .aggregate(core, playSqlModule, sampleAppExample, todoAppExample)
+  .enablePlugins(GhpagesPlugin, SiteScaladocPlugin, ScalaUnidocPlugin, ParadoxSitePlugin, ParadoxMaterialThemePlugin)
+  .settings(
+    // Publish documentation
+    git.remoteRepo := "[email protected]:zengularity/query-monad.git",
+    ghpagesNoJekyll := true,
+    Paradox / sourceDirectory := file("docsite"),
+    ParadoxMaterialThemePlugin.paradoxMaterialThemeSettings(Paradox),
+    Paradox / paradoxMaterialTheme ~= {
+      _.withFavicon("img/favicon.ico")
+//        .withLogo("img/logo.svg") // TODO Add logo?
+        .withRepository(uri("https://github.com/zengularity/query-monad"))
+    },
+    ScalaUnidoc / siteSubdirName := "api/latest",
+    addMappingsToSiteDir(ScalaUnidoc / packageDoc / mappings, ScalaUnidoc / siteSubdirName),
+    ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(core, playSqlModule)
+  )

docsite/contributing.md

@@ -0,0 +1,3 @@
+# Contributing To The Project
+
+**TODO**

docsite/getting-started.md

@@ -0,0 +1,3 @@
+# Getting Started
+
+**TODO**

docsite/index.md

@@ -0,0 +1,24 @@
+# query-monad
+
+This documentation site is still a work-in-progress. In the mean time, check
+out [our README file on Github](https://github.com/zengularity/query-monad/blob/master/README.md).
+
+**TODO:** Short description here
+
+@@@ note
+
+* Cross-published for Scala 2.11 and 2.12.
+* Releases currently available on [Zengularity Entrepot](https://github.com/zengularity/entrepot).
+* API docs (scaladoc) available [here](api/latest/index.html).
+
+@@@
+
+@@toc { depth=3 }
+
+@@@ index
+
+ - [getting-started](getting-started.md)
+ - [contributing](contributing.md)
+ - [release-notes](release-notes/index.md)
+
+@@@

docsite/release-notes/0.1.0.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+**TODO**

docsite/release-notes/index.md

@@ -0,0 +1,10 @@
+# Release Notes
+
+@@toc { depth=1 }
+
+@@@ index
+
+ - [0.1.0](0.1.0.md)
+ - [release-process](release-process.md)
+
+@@@

docsite/release-notes/release-process.md

@@ -0,0 +1,3 @@
+# Release Process for `sbt-site`
+
+**TODO**

project/plugins.sbt

@@ -3,3 +3,9 @@ addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.3.7")
 
 // The Play plugin, used for the play-sql module
 addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.20")
+
+// Plugins for documentation publishing
+addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2")
+addSbtPlugin("io.github.jonas" % "sbt-paradox-material-theme" % "0.5.1")
+addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.2")