Skip to content

Add default 404 page to sbt-typelevel-site #871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abby-ql wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Add default 404 page to sbt-typelevel-site #871

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8f7040e
Add default 404.html via theme injection (working but unstyled version)
Feb 23, 2026
00e4ad3
snapshot version for local publishing
Feb 23, 2026
a200b01
refined 404 html in helium style
Feb 24, 2026
c3217e3
remove test snapshot version
Feb 24, 2026
cc31562
add user override if their own 404.md provided
Feb 24, 2026
42bcede
revert accidental versio setting change
Feb 24, 2026
f195e69
correct formating
Feb 24, 2026
3741d4b
correct linting
Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions site/src/main/scala/org/typelevel/sbt/site/GenericSiteSettings.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ import org.typelevel.sbt.TypelevelGitHubPlugin.gitHubUserRepo
import org.typelevel.sbt.TypelevelKernelPlugin.autoImport.tlIsScala3
import org.typelevel.sbt.TypelevelSitePlugin.autoImport.tlSiteApiUrl
import sbt.Def._
import sbt.Keys.baseDirectory
import sbt.Keys.developers
import sbt.Keys.scmInfo
import sbt.Keys.version
import sbt._

import java.net.URL

Expand All @@ -50,13 +52,26 @@ object GenericSiteSettings {
}

val themeExtensions: Initialize[ThemeProvider] = setting {

val rootDir = (ThisBuild / baseDirectory).value
val docsDir = rootDir / "docs"
val userProvided404 = (docsDir / "404.md").exists() || (docsDir / "404.html").exists()

new ThemeProvider {
def build[F[_]](implicit F: Async[F]): Resource[F, Theme[F]] =
ThemeBuilder[F]("sbt-typelevel-site Helium Extensions")
.addInputs(
tlSiteApiUrl.value.fold(InputTree[F]) { url =>
InputTree[F].addString(htmlForwarder(url), Path.Root / "api" / "index.html")
}
tlSiteApiUrl
.value
.fold(InputTree[F]) { url =>
InputTree[F].addString(htmlForwarder(url), Path.Root / "api" / "index.html")
}
.merge(
if (userProvided404)
InputTree[F]
else
InputTree[F].addString(default404Html, Path.Root / "404.html")
)
)
.addExtensions(
GitHubFlavor,
Expand Down Expand Up @@ -85,6 +100,31 @@ object GenericSiteSettings {
)
}

private val default404Html: String =
"""|<!DOCTYPE html>
|<html lang="en">
|<head>
| <meta charset="utf-8">
| <meta name="viewport" content="width=device-width, initial-scale=1">
| <title>Page not found</title>
| <link rel="stylesheet" href="helium/site/laika-helium.css">
| <script src="helium/site/laika-helium.js"></script>
|</head>
|<body>
| <main class="content">
| <h1 style="text-align:center; font-size:9rem; color:#d2d6dc; margin-top:10rem;">404</h1>
| <h2 style="text-align:center; margin-top:4rem;">Page Not Found</h2>
| <p style="text-align:center; margin-top:1.5rem;">
| Sorry, the page you were looking for does not exist
| </p>
| <p style="text-align:center; margin-top:1.5rem;">
| <a href="index.html">Click here to go back to the home page</a>
| </p>
| </main>
|</body>
|</html>
|""".stripMargin

private def htmlForwarder(to: URL) =
s"""|<!DOCTYPE html>
|<meta charset="utf-8">
Expand Down
Loading