Update the build to generate gh pages

Author: stanch

.github/workflows/ci.yml

@@ -1,13 +1,8 @@
 name: CI
-on:
-  push:
-    tags: ["*"]
-    branches: ['**', '!update/**', '!pr/**']
-  pull_request:
-    branches: ['**', '!update/**', '!pr/**']
+on: [push, pull_request]
 jobs:
-  docs:
-    name: Build docs
+  tests:
+    name: Run tests
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -16,9 +11,11 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
       - uses: coursier/cache-action@v6
-      - run: sbt docs/run
-  tests:
-    name: Run tests
+      - name: Run tests
+        run: |
+          sbt "+Test/compile; +test"
+  docs:
+    name: Build docs
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -27,6 +24,4 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
       - uses: coursier/cache-action@v6
-      - name: Run tests
-        run: |
-          sbt "+Test/compile; +test"
+      - run: sbt docs/run

.github/workflows/docs.yml

@@ -0,0 +1,19 @@
+name: docs
+on: [push]
+jobs:
+  docs:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - uses: coursier/cache-action@v6
+      - run: sbt docs/run
+      - uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          enable_jekyll: true
+          publish_dir: ./docs-gen/target/mdoc/.

README.md

@@ -5,148 +5,4 @@ This implementation is inspired by
 [the original paper by Huet](https://www.st.cs.uni-saarland.de/edu/seminare/2005/advanced-fp/docs/huet-zipper.pdf),
 as well as the [Argonaut’s JSON Zipper](http://argonaut.io/doc/zipper/).
 
-Consider the following example:
-
-```scala
-// Define a tree data structure
-case class Tree(x: Int, c: List[Tree] = List.empty)
-
-// Create a tree
-val tree = Tree(
-  1, List(
-    Tree(
-      11, List(
-        Tree(111),
-        Tree(112)
-      )
-    ),
-    Tree(
-      12, List(
-        Tree(121),
-        Tree(
-          122, List(
-            Tree(1221),
-            Tree(1222)
-          )
-        ),
-        Tree(123)
-      )
-    ),
-    Tree(13)
-  )
-)
-```
-
-<img src="./docs/images/readme/tree.png" height="500px" />
-
-Since the tree is immutable, modifying it can be a pain,
-but it’s easily solved with a Zipper:
-
-```scala
-import zipper._
-
-// Use a Zipper to move around and change data
-val modified = {
-  Zipper(tree)
-    .moveDownAt(1)          // 12
-    .moveDownRight          // 123
-    .deleteAndMoveLeft      // 122
-    .moveDownLeft           // 1221
-    .update(_.copy(x = -1))
-    .moveRight              // 1222
-    .set(Tree(-2))
-    .moveUp                 // 122
-    .moveUp                 // 12
-    .rewindLeft             // 11
-    .moveDownRight          // 112
-    .moveLeftBy(1)          // 111
-    .deleteAndMoveUp        // 11
-    .commit                 // commit the changes and return the result
-}
-```
-
-Here’s what the modified tree looks like:
-
-<img src="./docs/images/readme/modified.png" height="500px" />
-
-If we draw both trees side by side, we’ll see that
-the unchanged parts are shared:
-
-<img src="./docs/images/readme/both.png" height="500px" />
-
-### Usage
-
-Include these lines in your `build.sbt`:
-
-```scala
-// for JVM
-libraryDependencies += "io.github.stanch" %% "zipper" % "0.5.2"
-
-// for Scala.js
-libraryDependencies += "io.github.stanch" %%% "zipper" % "0.5.2"
-```
-
-#### Unzip
-
-In order for the Zipper to work on your data structure `Tree`, you need an implicit instance of `Unzip[Tree]`.
-`Unzip` is defined as follows:
-
-```scala
-trait Unzip[A] {
-  def unzip(node: A): List[A]
-  def zip(node: A, children: List[A]): A
-}
-```
-
-As we saw before, the library can automatically derive `Unzip[Tree]`
-if the `Tree` is a case class that has a single field of type `List[Tree]`.
-It is also possible to derive an `Unzip[Tree]` for similar cases, but with other collections:
-
-```scala
-scala> case class Tree(x: Int, c: Vector[Tree] = Vector.empty)
-defined class Tree
-
-scala> implicit val unzip = Unzip.For[Tree, Vector].derive
-unzip: zipper.Unzip[Tree] = zipper.GenericUnzipInstances$For$$anon$2@6389ff1a
-```
-
-The automatic derivation is powered by [shapeless](https://github.com/milessabin/shapeless).
-
-#### Moves, failures and recovery
-
-There are many operations defined on a `Zipper`.
-Some of them are not safe, e.g. `moveLeft` will fail with an exception
-if there are no elements on the left.
-For all unsafe operations a safe version is provided, which is prefixed with `try`.
-These operations return a `Zipper.MoveResult`, which allows to recover from the failure or return to the original state:
-
-```scala
-scala> val tree = Tree(1, Vector(Tree(3), Tree(4)))
-tree: Tree = Tree(1,Vector(Tree(3,Vector()), Tree(4,Vector())))
-
-scala> val modified = {
-     |   Zipper(tree)
-     |     .moveDownLeft
-     |     .tryMoveLeft.getOrElse(_.insertLeft(Tree(2)).moveLeft)
-     |     .commit
-     | }
-modified: Tree = Tree(1,Vector(Tree(2,Vector()), Tree(3,Vector()), Tree(4,Vector())))
-```
-
-#### Loops
-
-`Zipper` provides a looping functionality, which can be useful with recursive data:
-
-```scala
-scala> val tree = Tree(1, Vector(Tree(2), Tree(3), Tree(5)))
-tree: Tree = Tree(1,Vector(Tree(2,Vector()), Tree(3,Vector()), Tree(5,Vector())))
-
-scala> val modified = {
-     |   Zipper(tree)
-     |     .moveDownLeft
-     |     .repeatWhile(_.x < 5, _.tryMoveRight)
-     |     .insertRight(Tree(4))
-     |     .commit
-     | }
-modified: Tree = Tree(1,Vector(Tree(2,Vector()), Tree(3,Vector()), Tree(5,Vector()), Tree(4,Vector())))
-```
+See https://stanch.github.io/zipper for more details.

_config.yml docs/_config.yml

@@ -37,7 +37,7 @@ val tree = Tree(
 )
 ```
 
-<img src="/docs/images/readme/tree.png" height="500px" />
+<img src="images/tree.png" height="500px" />
 
 Since the tree is immutable, modifying it can be a pain,
 but it’s easily solved with a Zipper:
@@ -67,12 +67,12 @@ val modified = {
 
 Here’s what the modified tree looks like:
 
-<img src="/docs/images/readme/modified.png" height="500px" />
+<img src="images/modified.png" height="500px" />
 
 If we draw both trees side by side, we’ll see that
 the unchanged parts are shared:
 
-<img src="/docs/images/readme/both.png" height="500px" />
+<img src="images/both.png" height="500px" />
 
 ### Usage