Merge pull request #200 from Kevin-Lee/update-docs

Updated: docs

.github/workflows/publish-github-pages.yml

@@ -1,9 +1,7 @@
 name: Publish GitHub Pages
 
 on:
-  push:
-    branches:
-      - publish-docs
+  workflow_dispatch:
 
 jobs:
   build:
@@ -13,7 +11,7 @@ jobs:
     strategy:
       matrix:
         scala:
-          - { version: "2.13.3", binary-version: "2.13", java-version: "11" }
+          - { version: "2.13.5", binary-version: "2.13", java-version: "11" }
 
     steps:
       - uses: actions/checkout@v2
@@ -25,24 +23,19 @@ jobs:
           node-version: '14.4.0'
           registry-url: 'https://registry.npmjs.org'
 
-      - name: Cache Coursier
-        uses: actions/cache@v1
+      - name: Cache SBT
+        uses: actions/cache@v2
         with:
-          path: ~/.cache/coursier
-          key: ${{ runner.os }}-coursier-scala-${{ matrix.scala.binary-version }}-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('**/build.properties') }}
+          path: |
+            ~/.ivy2/cache
+            ~/.cache/coursier
+            ~/.sbt
+          key: ${{ runner.os }}-sbt-${{ matrix.scala.binary-version }}-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('**/build.properties') }}
           restore-keys: |
-            ${{ runner.os }}-coursier-scala-${{ matrix.scala.binary-version }}-
-
-      - name: Cache Ivy
-        uses: actions/cache@v1
-        with:
-          path: ~/.ivy2/cache
-          key: ${{ runner.os }}-ivy-scala-${{ matrix.scala.binary-version }}-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('**/build.properties') }}
-          restore-keys: |
-            ${{ runner.os }}-ivy-scala-${{ matrix.scala.binary-version }}-
+            ${{ runner.os }}-sbt-${{ matrix.scala.binary-version }}-
 
       - name: Cache npm
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
@@ -61,6 +54,7 @@ jobs:
             clean \
             docs/mdoc \
             docs/docusaurGenerateAlgoliaConfigFile \
+            docs/docusaurGenerateGoogleAnalyticsConfigFile \
             docs/docusaurInstall \
             docs/docusaurCleanBuild \
             docs/docusaurBuild \

build.sbt

@@ -202,6 +202,16 @@ lazy val docs = (project in file("generated-docs"))
   .enablePlugins(MdocPlugin, DocusaurPlugin)
   .settings(
     name := prefixedProjectName("docs"),
+    mdocVariables := Map(
+      "VERSION" -> (ThisBuild / version).value,
+      "SUPPORTED_SCALA_VERSIONS" -> {
+        val versions = props.CrossScalaVersions.map(v => s"`$v`")
+        if (versions.length > 1)
+          s"${versions.init.mkString(", ")} and ${versions.last}"
+        else
+          versions.mkString
+      },
+    ),
     docusaurDir := (ThisBuild / baseDirectory).value / "website",
     docusaurBuildDir := docusaurDir.value / "build",
     gitHubPagesOrgName := props.GitHubUsername,

docs/getting-started.md

@@ -9,17 +9,20 @@ title: 'Getting Started'
 [![Release Status](https://github.com/Kevin-Lee/just-fp/workflows/Release/badge.svg)](https://github.com/Kevin-Lee/just-fp/actions?workflow=Release)
 [![Coverage Status](https://coveralls.io/repos/github/Kevin-Lee/just-fp/badge.svg?branch=main)](https://coveralls.io/github/Kevin-Lee/just-fp?branch=main)
 
-[![Download](https://api.bintray.com/packages/kevinlee/maven/just-fp/images/download.svg)](https://bintray.com/kevinlee/maven/just-fp/_latestVersion)
-[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.kevinlee/just-fp_2.13/badge.svg)](https://search.maven.org/artifact/io.kevinlee/just-fp_2.13)
-[![Latest version](https://index.scala-lang.org/kevin-lee/just-fp/just-fp/latest.svg)](https://index.scala-lang.org/kevin-lee/just-fp/just-fp)
+[![Download](https://api.bintray.com/packages/kevinlee/maven/just-fp-core/images/download.svg)](https://bintray.com/kevinlee/maven/just-fp-core/_latestVersion)
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.kevinlee/just-fp-core_2.13/badge.svg)](https://search.maven.org/artifact/io.kevinlee/just-fp-core_2.13)
+[![Latest version](https://index.scala-lang.org/kevin-lee/just-fp/just-fp-core/latest.svg)](https://index.scala-lang.org/kevin-lee/just-fp/just-fp-core)
+
+* Supported Scala Versions: @SUPPORTED_SCALA_VERSIONS@
 
 just-fp is a small Functional Programming library. This is not meant to be an alternative to Scalaz or Cats. The reason for having this library is that in your project you don't want to have Scalaz or Cats as its dependency and you only need much smaller set of functional programming features than what Scalaz or Cats offers. So the users of your library can choose Scalaz or Cats to be used with your library.
 
 ## Getting Started
+
 In `build.sbt`,
 
 ```scala
-libraryDependencies += "io.kevinlee" %% "just-fp" % "1.3.5"
+libraryDependencies += "io.kevinlee" %% "just-fp-core" % "@VERSION@"
 ```
 then import