docs (#122)

* Add site docs * Site doc
cheleb · Nov 25, 2023 · 3645ac4 · 3645ac4
1 parent d7c0638
commit 3645ac4
Show file tree

Hide file tree

Showing 10 changed files with 9,987 additions and 2,519 deletions.
diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -50,15 +50,17 @@ jobs:
 #        run: sbt client/fastLinkJS
       - name: Vite build
         run: |
-          cd examples/client
+          pushd examples/client
           npm run build
+          popd
+          sbt makeSite
       - name: Setup Pages
         uses: actions/configure-pages@v3
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
           # Upload dist repository
-          path: "./examples/client/dist"
+          path: "target/site"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -19,7 +19,7 @@
         {
             "label": "npmInstall",
             "type": "shell",
-            "command": "cd examples/client; npm i",
+            "command": "pushd examples/client; npm i; popd; NODE_OPTIONS='--openssl-legacy-provider' DEV=1 sbt \"client/fastLinkJS\"",
             "presentation": {
                 "panel": "dedicated",
                 "group": "runDevCmd",

diff --git a/README.md b/README.md
@@ -21,9 +21,6 @@ Client code is in [example/client](./example/client/src/main/scala/HelloWorld.sc
 
 ### Development
 
-
-Insure [dev mode](example/client/package.json#L5) is on `fastLinkJS` and not `fullLinkJS` (production mode)
-
 * VSCode with metals
 
 Just open the project with vscode and enjoy [the magic](.vscode/tasks.json)

diff --git a/build.sbt b/build.sbt
@@ -2,6 +2,9 @@
 import java.nio.charset.StandardCharsets
 import org.scalajs.linker.interface.ModuleSplitStyle
 
+lazy val currentYear: String =
+  java.util.Calendar.getInstance().get(java.util.Calendar.YEAR).toString
+
 val scala33 = "3.3.1"
 
 inThisBuild(
@@ -219,3 +222,35 @@ Global / onLoad := {
 
   (Global / onLoad).value
 }
+enablePlugins(
+  SiteScaladocPlugin,
+  SitePreviewPlugin,
+  ScalaUnidocPlugin,
+  GhpagesPlugin
+)
+
+ScalaUnidoc / siteSubdirName := ""
+addMappingsToSiteDir(
+  ScalaUnidoc / packageDoc / mappings,
+  ScalaUnidoc / siteSubdirName
+)
+git.remoteRepo := "[email protected]:cheleb/laminar-form-derivation.git"
+ghpagesNoJekyll := true
+Compile / doc / scalacOptions ++= Seq(
+  "-siteroot",
+  "docs",
+  "-project",
+  "Laminar Form Derivation",
+  "-groups",
+  "-project-version",
+  version.value,
+  "-revision",
+  version.value,
+  "-default-templates",
+  "static-site-main",
+  "-project-footer",
+  s"Copyright (c) 2022-$currentYear, Olivier NOUGUIER",
+  "-Ygenerate-inkuire",
+  "-skip-by-regex:demo\\..*",
+  "-skip-by-regex:samples\\..*"
+)
diff --git a/docs/_assets/.gitignore b/docs/_assets/.gitignore
@@ -0,0 +1 @@
+laminar-form-derivation/
diff --git a/docs/_docs/index.html b/docs/_docs/index.html
@@ -0,0 +1,11 @@
+---
+layout: main
+---
+
+<h1>Laminar Form Derivation</h1>
+
+<p>
+    Laminar Form Derivation is a library that allows you to derive a form from a case class.
+</p>
+
+<span onclick='window.open("/laminar-form-derivation/index.html", "_blank")'> 🚀 Demo</span>
diff --git a/docs/_layouts/main.html b/docs/_layouts/main.html
@@ -0,0 +1,11 @@
+<html>
+
+<head>
+    <title>Hello, world!</title>
+</head>
+
+<body>
+    {{ content }}
+</body>
+
+</html>