Merge pull request #491 from alejandrohdezma/docs/docusaurus

Build website with Docusarurus

Author: alejandrohdezma

docs/LICENSE.md .github/docs/LICENSE.mddocs/LICENSE.md renamed to .github/docs/LICENSE.md

@@ -58,11 +58,11 @@ jobs:
           - 17
     steps:
       - name: Checkout project
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
         with:
           ref: ${{ github.head_ref }}
 
-      - uses: actions/setup-java@de1bb2b0c5634f0fc4438d7aa9944e68f9bf86cc # v3.6.0
+      - uses: actions/setup-java@3f07048e3d294f56e9b90ac5ea2c6f74e9ad0f98 # v3.10.0
         with:
           distribution: "liberica"
           java-version: ${{ matrix.jdk }}

docs/README.md .github/docs/README.mddocs/README.md renamed to .github/docs/README.md

@@ -29,15 +29,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout project
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
         with:
           fetch-depth: 0
 
       - name: Check latest tag follows semantic versioning
         if: github.event_name == 'push'
         uses: alejandrohdezma/actions/check-semver-tag@v1
 
-      - uses: actions/setup-java@de1bb2b0c5634f0fc4438d7aa9944e68f9bf86cc # v3.6.0
+      - uses: actions/setup-java@3f07048e3d294f56e9b90ac5ea2c6f74e9ad0f98 # v3.10.0
         with:
           distribution: "liberica"
           java-version: "11"
@@ -59,13 +59,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout project
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c # v3.3.0
         with:
           fetch-depth: 0
           ref: main
           token: ${{ secrets.ADMIN_GITHUB_TOKEN }}
 
-      - uses: actions/setup-java@de1bb2b0c5634f0fc4438d7aa9944e68f9bf86cc # v3.6.0
+      - uses: actions/setup-java@3f07048e3d294f56e9b90ac5ea2c6f74e9ad0f98 # v3.10.0
         with:
           distribution: "liberica"
           java-version: "17"

.github/workflows/ci.yml

@@ -4,24 +4,21 @@ ThisBuild / pluginCrossBuild / sbtVersion := "1.2.8"
 ThisBuild / Test / parallelExecution      := false
 
 addCommandAlias("ci-test", "fix --check; mdoc; test; publishLocal; scripted")
-addCommandAlias("ci-docs", "github; mdoc; headerCreateAll; publishToGitHubPages")
+addCommandAlias("ci-docs", "github; mdoc; headerCreateAll; docusaurusPublishGhpages")
 addCommandAlias("ci-publish", "github; ci-release")
 
 val `sbt-mdoc` = "org.scalameta" % "sbt-mdoc" % "[2.0,)" % Provided // scala-steward:off
 
 val `sbt-header` = "de.heikoseeberger" % "sbt-header" % "[5.6.0,)" % Provided // scala-steward:off
 
-lazy val documentation = project
-  .enablePlugins(MdocPlugin)
-  .settings(mdocOut := file("."))
+lazy val documentation = project.enablePlugins(MdocPlugin)
 
-lazy val site = project
-  .enablePlugins(MdocPlugin)
+lazy val website = project
+  .enablePlugins(MdocPlugin, DocusaurusPlugin)
   .settings(mdocIn := baseDirectory.value / "docs")
+  .settings(mdocOut := (Compile / target).value / "mdoc")
   .settings(watchTriggers += mdocIn.value.toGlob / "*.md")
   .settings(mdocVariables += "EXCLUDED" -> excludedContributors.value.mkString("- ", "\n- ", ""))
-  .enablePlugins(GitHubPagesPlugin)
-  .settings(gitHubPagesSiteDir := mdocOut.value)
 
 lazy val `sbt-github` = module
   .enablePlugins(SbtPlugin)

.github/workflows/release.yml

@@ -4,3 +4,5 @@ Compile / unmanagedSourceDirectories ++= Seq(
   (ThisBuild / baseDirectory).value.getParentFile / "modules" / "sbt-github-header" / "src" / "main" / "scala",
   (ThisBuild / baseDirectory).value.getParentFile / "modules" / "sbt-github" / "src" / "main" / "scala"
 )
+
+libraryDependencies += "org.typelevel" %% "jawn-parser" % "1.4.0"

build.sbt

@@ -1,12 +1,11 @@
 addSbtPlugin("ch.epfl.scala"             % "sbt-scalafix"          % "0.10.4")
 addSbtPlugin("com.alejandrohdezma"       % "sbt-fix"               % "0.7.0")
-addSbtPlugin("com.alejandrohdezma"       % "sbt-ci"                % "2.12.0")
+addSbtPlugin("com.alejandrohdezma"       % "sbt-ci"                % "2.13.0")
 addSbtPlugin("com.alejandrohdezma"       % "sbt-scalafmt-defaults" % "0.8.0")
 addSbtPlugin("com.alejandrohdezma"       % "sbt-scalafix-defaults" % "0.10.0")
 addSbtPlugin("com.github.sbt"            % "sbt-ci-release"        % "1.5.11")
 addSbtPlugin("de.heikoseeberger"         % "sbt-header"            % "5.9.0")
 addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat"          % "0.4.2")
 addSbtPlugin("org.scalameta"             % "sbt-mdoc"              % "2.3.7")
 addSbtPlugin("org.scalameta"             % "sbt-scalafmt"          % "2.5.0")
-addSbtPlugin("io.kevinlee"               % "sbt-github-pages"      % "0.12.0")
 addSbtPlugin("com.alejandrohdezma"       % "sbt-modules"           % "0.2.0")