Build search index on website

.github/workflows/publish-site.yml

@@ -24,6 +24,13 @@ jobs:
         run: "sbt 'set ThisBuild / tlFatalWarningsInCi := false' documentation/mdoc"
       - name: "Build site"
         run: "sbt 'set ThisBuild / tlFatalWarningsInCi := false' makeSite"
+      - name: "Install stork"
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: stork-search --locked
+      - name: "Build search index"
+        run: 'stork build --input target/site/index.toml --output target/site/index.st'
       - uses: actions/upload-artifact@v3
         with:
           name: site
@@ -33,3 +40,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./target/site
+          exclude_assets: '.github,**/index.toml'

build.sbt

@@ -119,7 +119,7 @@ val root = tlCrossRootProject
     finiteState
   )
   .settings(commonSettings)
-  .enablePlugins(NoPublishPlugin, ScalaUnidocPlugin, SiteScaladocPlugin, NanocPlugin, GhpagesPlugin)
+  .enablePlugins(NoPublishPlugin, ScalaUnidocPlugin, SiteScaladocPlugin, NanocPlugin)
   .settings(
     ScalaUnidoc / unidoc / unidocProjectFilter := inProjects(
       cbor.jvm,
@@ -133,15 +133,11 @@ val root = tlCrossRootProject
       jsonInterpolators.jvm,
       text.jvm,
       xml.jvm,
-      scalaXml.jvm,
-      finiteState.jvm,
-      benchmarks.jvm
+      scalaXml.jvm
     ),
     ScalaUnidoc / siteSubdirName := "api",
     addMappingsToSiteDir(ScalaUnidoc / packageDoc / mappings, ScalaUnidoc / siteSubdirName),
-    Nanoc / sourceDirectory := file("site"),
-    git.remoteRepo := scmInfo.value.get.connection.replace("scm:git:", ""),
-    ghpagesNoJekyll := true
+    Nanoc / sourceDirectory := file("site")
   )
 
 lazy val text = crossProject(JVMPlatform, JSPlatform, NativePlatform)

project/plugins.sbt

@@ -13,8 +13,6 @@ addSbtPlugin("pl.project13.scala" % "sbt-jmh" % "0.4.3")
 
 addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.1")
 
-addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3")
-
 addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.11.0")
 
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "1.2.0")

site/Rules

@@ -14,6 +14,11 @@ compile '/**/index.md' do
   write item.identifier.without_ext + '.html'
 end
 
+compile '/**/*.toml' do
+  filter :erb
+  write item.identifier.to_s
+end
+
 compile '/api/**/*' do
   write item.identifier.to_s
 end

site/content/css/stork.css

@@ -0,0 +1,191 @@
+.stork-wrapper-flat {
+  position: relative;
+  font-family: inherit;
+  box-sizing: border-box;
+  font-size: 1em;
+
+  --stork-blue-2: #a5d8ff;
+  --stork-blue-3: #74c0fc;
+  --stork-blue-4: #4dabf7;
+  --stork-blue-5: #339af0;
+  --stork-blue-7: #1c7ed6;
+  --stork-gray-8: #343a40;
+  --stork-gray-9: #212529;
+  --stork-yellow-2: #ffec99;
+
+  --stork-border-color: hsl(0, 0%, 80%);
+  --stork-background-color: hsla(0, 0%, 97%);
+  --stork-text-color: var(--stork-gray-9);
+
+  --stork-input-height: 2.4em;
+}
+
+.stork-wrapper-flat *,
+.stork-wrapper-flat *:before,
+.stork-wrapper-flat *:after {
+  box-sizing: border-box;
+}
+
+.stork-wrapper-flat .stork-input {
+  width: 100%;
+  height: var(--stork-input-height);
+  font-size: 1em;
+  padding: 0.4em 0.8em;
+  position: relative;
+  border: 2px solid var(--stork-border-color);
+  border-radius: calc(var(--stork-input-height) / 2);
+  background-color: var(--stork-background-color);
+  color: var(--stork-text-color);
+  font-family: inherit;
+}
+
+.stork-wrapper-flat .stork-input:focus {
+  outline: none;
+}
+
+.stork-wrapper-flat .stork-progress {
+  position: absolute;
+  display: block;
+  content: "";
+  bottom: 1px;
+  background-color: var(--stork-blue-5);
+  box-shadow: 0 0 8px var(--stork-blue-4);
+  height: 1px;
+  transition: width 0.25s ease, opacity 0.4s ease 0.4s;
+  margin-left: calc(var(--stork-input-height) / 2);
+  max-width: calc(100% - var(--stork-input-height));
+}
+
+.stork-wrapper-flat .stork-output {
+  position: absolute;
+  width: 100%;
+  margin-top: 0.5em;
+  border-radius: 6px;
+  display: flex;
+  flex-direction: column;
+  z-index: 100;
+  color: var(--stork-text-color);
+  font-weight: 400;
+  font-family: inherit;
+}
+
+.stork-wrapper-flat .stork-attribution a:link,
+.stork-wrapper-flat .stork-attribution a:visited {
+  color: var(--stork-blue-7);
+}
+
+.stork-wrapper-flat .stork-output-visible {
+  border: 2px solid var(--stork-border-color);
+  background: var(--stork-background-color);
+}
+
+.stork-wrapper-flat .stork-message {
+  width: 100%;
+  padding: 0.5em 1em;
+  color: var(--stork-text-color);
+}
+
+.stork-wrapper-flat .stork-attribution {
+  width: 100%;
+  padding: 0.5em 1em;
+  font-size: 0.8em;
+  color: var(--stork-text-color);
+}
+
+.stork-wrapper-flat .stork-results {
+  margin: 0;
+  padding: 0;
+  width: 100%;
+  list-style-type: none;
+  max-height: 25em;
+  overflow-y: scroll;
+  border-top: 1px solid var(--stork-border-color);
+  border-bottom: 1px solid var(--stork-border-color);
+}
+
+.stork-wrapper-flat .stork-result:not(:last-child) {
+  border-bottom: 1px solid var(--stork-border-color);
+}
+
+.stork-wrapper-flat .stork-result.selected {
+  background: var(--stork-blue-2);
+}
+
+.stork-wrapper-flat .stork-result a:link {
+  padding: 1em;
+  display: block;
+  color: currentcolor;
+  text-decoration: none;
+}
+
+.stork-wrapper-flat .stork-result p {
+  margin: 0;
+}
+
+.stork-wrapper-flat .stork-title {
+  font-weight: bold;
+  font-size: 0.95em;
+  margin: 0;
+  color: var(--stork-text-color);
+
+  /* Flexbox container for the title and the score, when debugging */
+  display: flex;
+  justify-content: space-between;
+}
+
+.stork-wrapper-flat .stork-excerpt-container {
+  margin-top: 0.75em;
+}
+
+.stork-wrapper-flat .stork-excerpt {
+  font-size: 0.8em;
+  line-height: 1;
+  margin: 0;
+  color: var(--stork-gray-8);
+
+  /* Flexbox container for the title and the score, when debugging */
+  display: flex;
+  justify-content: space-between;
+}
+
+.stork-wrapper-flat .stork-excerpt:not(:last-of-type) {
+  margin-bottom: 0.6em;
+}
+
+.stork-wrapper-flat .stork-highlight {
+  background-color: var(--stork-yellow-2);
+  padding: 0 0.1em;
+}
+
+.stork-wrapper-flat .stork-error {
+  outline: 2px solid #c92a2a;
+}
+
+.stork-wrapper-flat .stork-close-button {
+  position: absolute;
+  right: 0;
+  margin: 0.5em 0.5em;
+  height: 1.4em;
+  width: 1.4em;
+  padding: 0px;
+  background: hsl(0, 0%, 85%);
+  border: 1px solid hsla(0, 0%, 70%);
+  font-size: 1em;
+  color: hsl(0, 0%, 50%);
+  border-radius: 50%;
+  line-height: 1;
+}
+
+.stork-wrapper-flat .stork-close-button svg {
+  width: 11px;
+  height: 11px;
+}
+
+.stork-wrapper-flat .stork-close-button:hover {
+  background: hsla(0, 0%, 78%);
+  cursor: pointer;
+}
+
+.stork-wrapper-flat .stork-close-button:active {
+  background: hsla(0, 0%, 65%);
+}

site/content/index.toml

@@ -0,0 +1,11 @@
+[input]
+<% @items.find_all('/documentation/**/*.md').each do |item| %>
+[[input.files]]
+path = "<%= item.reps[:default].raw_path %>"
+url = "<%= item.path %>"
+title = "<%= strip_html(item[:title]) %>"
+<% end %>
+
+[output]
+excerpts_per_result = 3
+displayed_results_count = 5

site/layouts/default.html

@@ -9,6 +9,12 @@
     <link type="text/css" rel="stylesheet" href="/css/materialize.min.css" media="screen,projection"/>
     <style>body{font-family: overpass, sans-serif; }</style>
 
+    <script type="text/javascript" src="/js/materialize.min.js"></script>
+
+    <!-- search index -->
+    <link rel="stylesheet" href="/css/stork.css" />
+    <script src="/js/stork.js"></script>
+
     <meta name="generator" content="Nanoc <%= Nanoc::VERSION %>">
   </head>
   <body>
@@ -22,6 +28,14 @@
               <li><a href="/documentation/">Documentation</a></li>
               <li><a href="/api/">Scaladoc</a></li>
               <li><a href="https://github.com/gnieh/fs2-data">Github</a></li>
+              <li><i class="material-icons">search</i></li>
+              <li>
+                <form>
+                  <div class="input-field">
+                    <input data-stork="search" id="search" type="search" required placeholder="Search the website" autocomplete="off" />
+                  </div>
+                </form>
+              </li>
             </ul>
           </div>
           <%# top level doc trick %>
@@ -47,6 +61,9 @@
           </div>
           <% end %>
         </nav>
+        <div class="stork-wrapper-flat">
+          <div data-stork="search-output" class="stork-output"></div>
+        </div>
 
     </header>
 
@@ -83,7 +100,6 @@
       </div>
     </footer>
 
-    <script type="text/javascript" src="/js/materialize.min.js"></script>
     <script type="text/javascript">
     document.addEventListener('DOMContentLoaded', function() {
       var elems = document.querySelectorAll('.sidenav');
@@ -93,6 +109,9 @@
       var elems = document.querySelectorAll('.tooltipped');
       var instances = M.Tooltip.init(elems, {});
     });
+
+    stork.initialize("/js/stork.wasm")
+    stork.register("search", "/index.st", { showCloseButton: false })
     </script>
-  </body>
+
 </html>

site/lib/helpers.rb

@@ -1,3 +1,5 @@
+use_helper Nanoc::Helpers::Text
+
 def modules_by_type
   @items.find_all("/documentation/*/index.md").group_by do |item|
     item[:type]

site/nanoc.yaml

@@ -1,7 +1,7 @@
 # A list of file extensions that Nanoc will consider to be textual rather than
 # binary. If an item with an extension not in this list is found,  the file
 # will be considered as binary.
-text_extensions: [ 'adoc', 'asciidoc', 'atom', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'tex', 'txt', 'xhtml', 'xml' ]
+text_extensions: [ 'adoc', 'asciidoc', 'atom', 'coffee', 'css', 'erb', 'haml', 'handlebars', 'hb', 'htm', 'html', 'js', 'less', 'markdown', 'md', 'ms', 'mustache', 'php', 'rb', 'rdoc', 'sass', 'scss', 'slim', 'tex', 'txt', 'xhtml', 'xml', 'toml']
 
 base_url: https://fs2-data.gnieh.org