Switch from lustre SSG and Djot to simplifile and Markdown

Author: GearsDatapacks

README.md

@@ -1,4 +1,4 @@
 # Gears' Website
 
 Code for [my website](https://gearsco.de), written in [Gleam](https://gleam.run),
-using [Lustre](https://lustre.build) and [Lustre SSG](https://hexdocs.pm/lustre_ssg).
+using [Lustre](https://lustre.build) and [Mork](https://hexdocs.mp/mork).

blog/gleam-test-timeouts.djot renamed to blog/gleam-test-timeouts.md

@@ -5,7 +5,7 @@ description = "By default, Gleam tests come with a timeout of 5 seconds. It's no
 ---
 
 If you don't care about the backstory and just want to know the answer, you can
-[skip there](#How-do-I-configure-my-test-timeout).
+[skip there](#how-do-i-configure-my-test-timeout).
 
 ## How Gleam tests work
 
@@ -33,7 +33,7 @@ so if any test runs for longer than that it is immediately terminated.
 
 EUnit has a somewhat unconventional API. As the default Gleam project explains,
 it runs all public functions whose names end in `_test`. But there's a second
-more obscure API, in the form of *test generators*.
+more obscure API, in the form of **test generators**.
 
 Test generators are another kind of EUnit test. Test generator functions end
 in `_test_` (note the trailing underscore), and they have the ability to configure

gleam.toml

@@ -1,6 +1,5 @@
 name = "website"
 version = "1.0.0"
-target = "javascript"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.
@@ -17,11 +16,13 @@ target = "javascript"
 gleam_stdlib = ">= 0.44.0 and < 2.0.0"
 lustre = ">= 5.0.2 and < 6.0.0"
 tom = ">= 1.1.0 and < 2.0.0"
-simplifile = ">= 2.2.0 and < 3.0.0"
-lustre_ssg = ">= 0.11.0 and < 1.0.0"
-jot = ">= 4.0.0 and < 5.0.0"
+simplifile = ">= 2.3.0 and < 3.0.0"
 pearl = ">= 2.2.0 and < 3.0.0"
 contour = ">= 1.2.1 and < 2.0.0"
+mork = ">= 1.8.0 and < 2.0.0"
+filepath = ">= 1.1.2 and < 2.0.0"
+frontmatter = ">= 1.0.1 and < 2.0.0"
+gleam_regexp = ">= 1.1.1 and < 2.0.0"
 
 [dev-dependencies]
 gleeunit = ">= 1.0.0 and < 2.0.0"

manifest.toml

@@ -2,13 +2,12 @@
 # You typically do not need to edit this file
 
 packages = [
+  { name = "casefold", version = "1.5.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "casefold", source = "hex", outer_checksum = "7DF0295BA71C525FADFBE6C3700C534EDE01ED512138F3EBF00AC158DE3AFF3C" },
   { name = "contour", version = "1.2.1", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_stdlib", "glexer", "houdini"], otp_app = "contour", source = "hex", outer_checksum = "C7895472BBAAC5D15DBDBAF6DD1847F6981F2F6132F726BAD30434A6E3BAAB95" },
-  { name = "envoy", version = "1.0.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "envoy", source = "hex", outer_checksum = "95FD059345AA982E89A0B6E2A3BF1CF43E17A7048DCD85B5B65D3B9E4E39D359" },
-  { name = "exception", version = "2.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "exception", source = "hex", outer_checksum = "329D269D5C2A314F7364BD2711372B6F2C58FA6F39981572E5CA68624D291F8C" },
   { name = "filepath", version = "1.1.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "filepath", source = "hex", outer_checksum = "B06A9AF0BF10E51401D64B98E4B627F1D2E48C154967DA7AF4D0914780A6D40A" },
+  { name = "frontmatter", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "frontmatter", source = "hex", outer_checksum = "D7FF83A8D22A52867809681EE254A3F989169F92539299958879FE47737DAB7A" },
   { name = "gleam_community_ansi", version = "1.4.3", build_tools = ["gleam"], requirements = ["gleam_community_colour", "gleam_regexp", "gleam_stdlib"], otp_app = "gleam_community_ansi", source = "hex", outer_checksum = "8A62AE9CC6EA65BEA630D95016D6C07E4F9973565FA3D0DE68DC4200D8E0DD27" },
   { name = "gleam_community_colour", version = "2.0.2", build_tools = ["gleam"], requirements = ["gleam_json", "gleam_stdlib"], otp_app = "gleam_community_colour", source = "hex", outer_checksum = "E34DD2C896AC3792151EDA939DA435FF3B69922F33415ED3C4406C932FBE9634" },
-  { name = "gleam_crypto", version = "1.5.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_crypto", source = "hex", outer_checksum = "50774BAFFF1144E7872814C566C5D653D83A3EBF23ACC3156B757A1B6819086E" },
   { name = "gleam_erlang", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "1124AD3AA21143E5AF0FC5CF3D9529F6DB8CA03E43A55711B60B6B7B3874375C" },
   { name = "gleam_json", version = "3.0.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "874FA3C3BB6E22DD2BB111966BD40B3759E9094E05257899A7C08F5DE77EC049" },
   { name = "gleam_otp", version = "1.2.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_stdlib"], otp_app = "gleam_otp", source = "hex", outer_checksum = "BA6A294E295E428EC1562DC1C11EA7530DCB981E8359134BEABC8493B7B2258E" },
@@ -17,23 +16,23 @@ packages = [
   { name = "gleeunit", version = "1.6.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "FDC68A8C492B1E9B429249062CD9BAC9B5538C6FBF584817205D0998C42E1DAC" },
   { name = "glexer", version = "2.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "splitter"], otp_app = "glexer", source = "hex", outer_checksum = "40A1FB0919FA080AD6C5809B4C7DBA545841CAAC8168FACDFA0B0667C22475CC" },
   { name = "houdini", version = "1.2.0", build_tools = ["gleam"], requirements = [], otp_app = "houdini", source = "hex", outer_checksum = "5DB1053F1AF828049C2B206D4403C18970ABEF5C18671CA3C2D2ED0DD64F6385" },
-  { name = "jot", version = "4.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib", "houdini", "splitter"], otp_app = "jot", source = "hex", outer_checksum = "E9E266D2768EA1238283D2CF125AA68095F17BAA4DDF3598360FD19F38593C59" },
   { name = "lustre", version = "5.3.5", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_json", "gleam_otp", "gleam_stdlib", "houdini"], otp_app = "lustre", source = "hex", outer_checksum = "5CBB5DD2849D8316A2101792FC35AEB58CE4B151451044A9C2A2A70A2F7FCEB8" },
-  { name = "lustre_ssg", version = "0.11.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_regexp", "gleam_stdlib", "jot", "lustre", "simplifile", "temporary", "tom"], otp_app = "lustre_ssg", source = "hex", outer_checksum = "D1F2B47EBE27C2B1DE6552A0883BC676D8EB076359D152FFA323FADDC74FFC41" },
+  { name = "mork", version = "1.8.0", build_tools = ["gleam"], requirements = ["casefold", "gleam_regexp", "gleam_stdlib", "splitter"], otp_app = "mork", source = "hex", outer_checksum = "6C48D71DC9DD20F23E63E9422B17F9D12689FB1D47A9DBEF97E982B638C8D1E9" },
   { name = "pearl", version = "2.2.0", build_tools = ["gleam"], requirements = ["gleam_community_ansi", "gleam_stdlib", "houdini", "splitter"], otp_app = "pearl", source = "hex", outer_checksum = "E5E14CE725542BA2516570D04140F0D1471761CCE27C6579C6396369FFF1DA9F" },
   { name = "simplifile", version = "2.3.0", build_tools = ["gleam"], requirements = ["filepath", "gleam_stdlib"], otp_app = "simplifile", source = "hex", outer_checksum = "0A868DAC6063D9E983477981839810DC2E553285AB4588B87E3E9C96A7FB4CB4" },
   { name = "splitter", version = "1.1.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "splitter", source = "hex", outer_checksum = "05564A381580395DCDEFF4F88A64B021E8DAFA6540AE99B4623962F52976AA9D" },
-  { name = "temporary", version = "1.0.0", build_tools = ["gleam"], requirements = ["envoy", "exception", "filepath", "gleam_crypto", "gleam_stdlib", "simplifile"], otp_app = "temporary", source = "hex", outer_checksum = "51C0FEF4D72CE7CA507BD188B21C1F00695B3D5B09D7DFE38240BFD3A8E1E9B3" },
   { name = "tom", version = "1.1.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "tom", source = "hex", outer_checksum = "0910EE688A713994515ACAF1F486A4F05752E585B9E3209D8F35A85B234C2719" },
 ]
 
 [requirements]
 contour = { version = ">= 1.2.1 and < 2.0.0" }
+filepath = { version = ">= 1.1.2 and < 2.0.0" }
+frontmatter = { version = ">= 1.0.1 and < 2.0.0" }
+gleam_regexp = { version = ">= 1.1.1 and < 2.0.0" }
 gleam_stdlib = { version = ">= 0.44.0 and < 2.0.0" }
 gleeunit = { version = ">= 1.0.0 and < 2.0.0" }
-jot = { version = ">= 4.0.0 and < 5.0.0" }
 lustre = { version = ">= 5.0.2 and < 6.0.0" }
-lustre_ssg = { version = ">= 0.11.0 and < 1.0.0" }
+mork = { version = ">= 1.8.0 and < 2.0.0" }
 pearl = { version = ">= 2.2.0 and < 3.0.0" }
-simplifile = { version = ">= 2.2.0 and < 3.0.0" }
+simplifile = { version = ">= 2.3.0 and < 3.0.0" }
 tom = { version = ">= 1.1.0 and < 2.0.0" }

src/build.gleam

@@ -1,47 +1,38 @@
+import filepath as path
 import gleam/io
 import gleam/list
 import lustre/element
-import lustre/ssg
+import simplifile as file
 import website/data/blog
 import website/page/blog_post
 import website/page/index
 
+const out_dir = "./priv"
+
 pub fn main() {
   let posts = blog.posts()
 
-  let build =
-    ssg.new("./priv")
-    |> ssg.add_static_route("/", index.view(posts))
-    |> ssg.add_static_dir("./static")
-    |> add_dynamic_routes(
-      "/blog",
-      posts,
-      fn(post) { post.slug },
-      blog_post.view,
-    )
-    |> ssg.build
+  let assert Ok(Nil) = file.delete(out_dir)
+  let assert Ok(Nil) = file.copy_directory("./static", out_dir)
+  create_page("/", index.view(posts))
+  list.each(posts, fn(post) {
+    create_page("blog/" <> post.slug, blog_post.view(post))
+  })
 
-  case build {
-    Ok(_) -> io.println("Build succeeded!")
-    Error(e) -> {
-      echo e
-      io.println("Build failed!")
-    }
+  io.println("Build succeeded!")
+}
+
+fn create_page(path: String, element: element.Element(a)) -> Nil {
+  let path = case path {
+    "/" <> path -> path
+    _ -> path
   }
+  let path = out_dir |> path.join(path) |> path.join("index.html")
+  write_file(path, element.to_document_string(element))
 }
 
-fn add_dynamic_routes(
-  config: ssg.Config(ssg.HasStaticRoutes, a, b),
-  path: String,
-  list: List(data),
-  slug: fn(data) -> String,
-  view: fn(data) -> element.Element(msg),
-) -> ssg.Config(ssg.HasStaticRoutes, a, b) {
-  list.fold(list, config, fn(config, data) {
-    ssg.add_static_route(
-      config,
-      path <> "/" <> slug(data) <> "/index",
-      view(data),
-    )
-  })
+fn write_file(to path: String, write contents: String) -> Nil {
+  let assert Ok(Nil) = file.create_directory_all(path.directory_name(path))
+  let assert Ok(Nil) = file.write(contents, to: path)
+  Nil
 }

src/website/component.gleam

@@ -67,15 +67,14 @@ pub fn text_page(header: String, content: List(Element(a))) -> Section(a) {
   ])
 }
 
-pub fn dangerous_html(html: String) -> Element(_) {
+pub fn raw_html(html: String) -> Element(_) {
   element.unsafe_raw_html("", "span", [], html)
 }
 
 pub fn code_block(language: Option(String), code_text: String) -> Element(_) {
   let code = case language {
-    Some("erlang") | Some("erl") ->
-      dangerous_html(pearl.highlight_html(code_text))
-    Some("gleam") -> dangerous_html(contour.to_html(code_text))
+    Some("erlang") | Some("erl") -> raw_html(pearl.highlight_html(code_text))
+    Some("gleam") -> raw_html(contour.to_html(code_text))
     _ -> html.text(code_text)
   }
 

src/website/data/blog.gleam

@@ -1,85 +1,37 @@
+import frontmatter
 import gleam/bool
 import gleam/dict.{type Dict}
 import gleam/list
+import gleam/option
 import gleam/string
-import jot
-import lustre/attribute
 import lustre/element
-import lustre/element/html
-import lustre/ssg/djot
 import simplifile
 import tom.{type Toml}
-import website/component
+import website/markdown
 
 pub fn posts() -> List(Post(_)) {
   let assert Ok(files) = simplifile.read_directory("blog/")
 
   list.filter_map(files, fn(file) {
-    use <- bool.guard(!string.ends_with(file, ".djot"), Error(Nil))
+    use <- bool.guard(!string.ends_with(file, ".md"), Error(Nil))
     let file_path = "blog/" <> file
     let assert Ok(contents) = simplifile.read(file_path)
 
-    let assert Ok(metadata) = djot.metadata(contents)
-    let contents = djot.render(contents, renderer())
+    let extracted = frontmatter.extract(contents)
+    let assert Ok(metadata) =
+      tom.parse(option.unwrap(extracted.frontmatter, ""))
+    let contents = markdown.render(extracted.content)
 
     let title = get_string_key(metadata, "title")
     let description = get_string_key(metadata, "description")
     let date = get_string_key(metadata, "date")
-    // Remove .djot suffix
-    let slug = string.drop_end(file, 5)
+    // Remove .md suffix
+    let slug = string.drop_end(file, 3)
 
     Ok(Post(title:, slug:, date:, contents:, description:))
   })
 }
 
-fn renderer() -> djot.Renderer(element.Element(_)) {
-  let default = djot.default_renderer()
-  djot.Renderer(
-    ..default,
-    link: fn(destination, references, content) {
-      case destination {
-        jot.Reference(ref) ->
-          case dict.get(references, ref) {
-            Ok(url) ->
-              html.a(
-                [
-                  attribute.href(url),
-                  attribute.target(target(url)),
-                  attribute.class("underline"),
-                ],
-                content,
-              )
-            Error(_) ->
-              html.a(
-                [
-                  attribute.href("#" <> ref),
-                  attribute.id("back-to-" <> ref),
-                ],
-                content,
-              )
-          }
-        jot.Url(url) ->
-          html.a(
-            [
-              attribute.href(url),
-              attribute.target(target(url)),
-              attribute.class("underline"),
-            ],
-            content,
-          )
-      }
-    },
-    codeblock: fn(_attrs, lang, code) { component.code_block(lang, code) },
-  )
-}
-
-fn target(url: String) -> String {
-  case url {
-    "https://" <> _ | "http://" <> _ -> "_blank"
-    _ -> ""
-  }
-}
-
 fn get_string_key(toml: Dict(String, Toml), key: String) -> String {
   let assert Ok(value) = dict.get(toml, key)
   let assert tom.String(value) = value