feat: use templating to build rules

drainpixie · drainpixie · commit c3bc47faece3 · 2025-09-25T14:08:59.000+02:00
diff --git a/website/build.py b/website/build.py
@@ -3,6 +3,7 @@
 import ast
 from pathlib import Path
 from shutil import copy2
+from string import Template
 
 
 def _extract_frontmatter(path: Path) -> dict[str, str] | None:
@@ -61,9 +62,14 @@ def main() -> None:
 
     toc = _build_toc(_collect_metadata(root))
 
-    _ = dist.mkdir(parents=True, exist_ok=True)
-    _ = copy2("index.html", dist / "index.html")
-    _ = (dist / "toc.html").write_text(toc, encoding="utf-8")
+    dist.mkdir(parents=True, exist_ok=True)
+    for name in ("index.html", "styles.css", "reset.css"):
+        _ = copy2(name, dist / name)
+
+    template = Path("rules.html").read_text(encoding="utf-8")
+    rules = Template(template).safe_substitute(rules=toc)
+
+    _ = (dist / "rules.html").write_text(rules, encoding="utf-8")
 
 
 if __name__ == "__main__":
diff --git a/website/index.html b/website/index.html
@@ -11,7 +11,9 @@ <h1>Proselint</h1>
       <p>
         <em>Proselint</em> is a linter for English prose.
         It highlights <em>clichés</em>, <em>jargon</em>, <em>illogical phrasing</em>, and other stylistic issues,
-        much like a spellchecker for style.
+        much like a spellchecker for style. <br /> <br />
+
+        You can navigate the available rules <a href="rules.html">here</a>.
       </p>
 
         <h2>Install</h2>
diff --git a/website/rules.html b/website/rules.html
@@ -0,0 +1,25 @@
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Proselint</title>
+    <link rel="stylesheet" href="styles.css">
+  </head>
+  <body>
+    <main>
+      <h1>Proselint</h1>
+      <p>
+      A list of the rules that <em>proselint</em> checks against, or <a href="/">go back.</a>.
+      </p>
+
+      $rules
+    </main>
+
+    <footer>
+      <p class="sm">
+        Crafted by <a href="https://github.com/amperser" rel="noopener noreferrer" target="_blank">Amperser Labs</a>
+      </p>
+    </footer>
+  </body>
+</html>
