Merge pull request #308 from s22s/feature/searchable-docs

New, modern documentation theme with built-in search

Author: metasim

build.sbt

@@ -129,20 +129,28 @@ lazy val experimental = project
 
 lazy val docs = project
   .dependsOn(core, datasource, pyrasterframes)
-  .enablePlugins(SiteScaladocPlugin, ParadoxPlugin, GhpagesPlugin, ScalaUnidocPlugin)
+  .enablePlugins(SiteScaladocPlugin, ParadoxPlugin, ParadoxMaterialThemePlugin, GhpagesPlugin, ScalaUnidocPlugin)
   .settings(
     apiURL := Some(url("http://rasterframes.io/latest/api")),
     autoAPIMappings := true,
     ghpagesNoJekyll := true,
     ScalaUnidoc / siteSubdirName := "latest/api",
     paradox / siteSubdirName := ".",
     paradoxProperties ++= Map(
-      "github.base_url" -> "https://github.com/locationtech/rasterframes",
       "version" -> version.value,
-      "scaladoc.org.apache.spark.sql.rf" -> "http://rasterframes.io/latest"
+      "scaladoc.org.apache.spark.sql.rf" -> "http://rasterframes.io/latest",
+      "github.base_url" -> ""
     ),
     paradoxNavigationExpandDepth := Some(3),
-    paradoxTheme := Some(builtinParadoxTheme("generic")),
+    Compile / paradoxMaterialTheme ~= { _
+      .withRepository(uri("https://github.com/locationtech/rasterframes"))
+      .withCustomStylesheet("assets/custom.css")
+      .withCopyright("""&copy; 2017-2019 <a href="https://astraea.earth">Astraea</a>, Inc. All rights reserved.""")
+      .withLogo("assets/images/RF-R.svg")
+      .withFavicon("assets/images/RasterFrames_32x32.ico")
+      .withColor("blue-grey", "light-blue")
+      .withGoogleAnalytics("UA-106630615-1")
+    },
     makeSite := makeSite
       .dependsOn(Compile / unidoc)
       .dependsOn((Compile / paradox)
@@ -157,6 +165,8 @@ lazy val docs = project
     addMappingsToSiteDir(Compile / paradox / mappings, paradox / siteSubdirName)
   )
 
+//ParadoxMaterialThemePlugin.paradoxMaterialThemeSettings(Paradox)
+
 lazy val bench = project
   .dependsOn(core % "compile->test")
   .settings(publish / skip := true)

docs/src/main/paradox/_template/assets/custom.css

@@ -0,0 +1,11 @@
+.md-left { float: left; }
+.md-right { float: right; }
+.md-clear { clear: both; }
+table { font-size: 80%; }
+code { font-size: 0.75em !important; }
+table a {
+    word-break: break-all;
+}
+.md-source-file.md-edit {
+    visibility: hidden;
+}