Add initial documentation site

Author: stringbean

.sbtopts

@@ -0,0 +1 @@
+-J-Djava.awt.headless=true

build.sbt

@@ -13,12 +13,24 @@ libraryDependencies ++= Seq(
 )
 
 lazy val xmlCompare = Project("xml-compare", file("xml-compare"))
+  .settings(
+    previewSite := {},
+    previewAuto := {}
+  )
 
 lazy val xmlScalatest = Project("xml-scalatest", file("xml-scalatest"))
   .dependsOn(xmlCompare)
+  .settings(
+    previewSite := {},
+    previewAuto := {}
+  )
 
 lazy val xmlSpecs2 = Project("xml-specs2", file("xml-specs2"))
   .dependsOn(xmlCompare)
+  .settings(
+    previewSite := {},
+    previewAuto := {}
+  )
 
 lazy val root = project
   .in(file("."))
@@ -39,6 +51,13 @@ lazy val root = project
     siteSubdirName in ScalaUnidoc := "api",
     addMappingsToSiteDir(mappings in (ScalaUnidoc, packageDoc), siteSubdirName in ScalaUnidoc),
     gitRemoteRepo := "[email protected]:stringbean/scala-xml-compare.git",
-    ghpagesNoJekyll := true
+    ghpagesNoJekyll := true,
+    paradoxTheme := Some(builtinParadoxTheme("generic")),
+    sourceDirectory in Paradox := baseDirectory.value / "docs",
+    sourceDirectory in Paradox in paradoxTheme := baseDirectory.value / "docs" / "_template",
+    git.remoteRepo := "[email protected]:stringbean/scala-xml-compare.git",
+    paradoxProperties in Paradox ++= Map(
+      "scaladoc.software.purpledragon.xml.base_url" -> ".../api"
+    )
   )
-  .enablePlugins(ScalaUnidocPlugin, GhpagesPlugin)
+  .enablePlugins(ScalaUnidocPlugin, GhpagesPlugin, ParadoxSitePlugin)

docs/_template/navigation.st

@@ -0,0 +1,15 @@
+<div class="nav-home">
+<a href="$page.home.href$" $if(page.home.active)$class="active"$endif$>
+<span class="home-icon">⌂</span>$page.home.title$
+</a>
+<div class="version-number">
+$page.properties.("project.version.short")$
+</div>
+<div class="scaladoc">
+<a href="$page.base$api/index.html"><span class="home-icon">§</span>Scaladocs</a>
+</div>
+</div>
+$groups()$
+<div class="nav-toc">
+$page.navigation$
+</div>

docs/comparing-xml.md

@@ -0,0 +1,8 @@
+# Comparing XML
+
+
+## Comparison Options
+
+By default the following options are used:
+
+* `IgnoreNamespacePrefix`

docs/index.md

@@ -0,0 +1,32 @@
+# scala-xml-compare
+
+scala-xml-compare is a small Scala library for comparing XML documents.
+
+## Getting Started
+
+@@@vars
+```scala
+libraryDependencies += "purpledragon.software" %% "scala-xml" % "$project.version$"
+```
+@@@
+
+Companion libraries are also provided for comparing XML from [Scalatest](http://scalatest.org/) and
+[Specs2](https://etorreborre.github.io/specs2/):
+
+@@@vars
+```scala
+// scalatest
+libraryDependencies += "purpledragon.software" %% "scala-scalatest" % "$project.version$" % Test
+
+// specs2
+libraryDependencies += "purpledragon.software" %% "scala-specs2" % "$project.version$" % Test
+```
+@@@
+
+@@@ index
+
+* [Comparing XML](comparing-xml.md)
+* [Scalatest](scalatest.md)
+* [Specs2](specs2.md)
+* [Scaladocs](@scaladoc[XmlDiff](software.purpledragon.xml.compare.XmlDiff))
+@@@

docs/scalatest.md

@@ -0,0 +1,7 @@
+# Scalatest
+
+Assertions can be made in [Scalatest](http://www.scalatest.org) tests using the `beXml` helper:
+
+```scala
+result should beXml(<example>1</example>)
+```

docs/specs2.md

@@ -0,0 +1,7 @@
+# Specs2
+
+Assertions can be made in [Specs2](https://etorreborre.github.io/specs2/) tests using the `beXml` helper:
+
+```scala
+result should beXml(<example>1</example>)
+```

project/plugins.sbt

@@ -11,3 +11,5 @@ addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.2-1")
 // documentation
 addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.2")
 addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.2")
+addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.3.2")
+addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.3.3")