Merge branch 'doc-restyle'

Author: weavejester

bb.edn

@@ -10,8 +10,10 @@
   {:depends [mkdirs]
    :task (doseq [[src dest] {"site/logo.svg"   "build/logo.svg"
                              "site/index.html" "build/index.html"
-                             "site/style.css"  "build/style.css"}]
+                             "site/style.css"  "build/style.css"
+                             "docs/style.css"  "build/docs/style.css"
+                             "docs/reset.css"  "build/docs/reset.css"}]
            (fs/copy src dest {:replace-existing true}))}
   build
   {:depends [docstrings files]
-   :task (shell "asciidoctor -D build/docs -b html5 index.adoc")}}}
+   :task (shell "asciidoctor -D build/docs -b html5 docs/index.adoc")}}}

build.clj

@@ -67,7 +67,7 @@
 
 (ig/load-annotations)
 
-(with-open [writer (io/writer "keywords.adoc")]
+(with-open [writer (io/writer "docs/keywords.adoc")]
   (binding [*out* writer]
     (println "[.concise-index]")
     (println ".Index")
@@ -82,8 +82,7 @@
         (println "[discrete]")
         (println "###" kw)
         (newline)
-        (println (str "*Dependency:* `"
-                      (get-dependency (find-resource kw)) "`"))
+        (println (str "`" (get-dependency (find-resource kw)) "`"))
         (newline)
         (println doc)))))
 

docinfo.html

@@ -0,0 +1,5 @@
+<link rel="preconnect" href="https://fonts.googleapis.com">
+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+<link href="https://fonts.googleapis.com/css2?family=Barlow+Condensed:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&family=Bebas+Neue&family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&family=Open+Sans:ital,wght@0,300..800;1,300..800&display=swap" rel="stylesheet">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/7.0.1/css/solid.min.css" integrity="sha512-EHa6vH03/Ty92WahM0/tet1Qicl76zihDCkBnFhN3kFGQkC+mc86d7V+6y2ypiLbk3h0beZAGdUpzfMcb06cMg==" crossorigin="anonymous" referrerpolicy="no-referrer">
+<link href="style.css" rel="stylesheet">

docs/docinfo.html

@@ -1,16 +1,24 @@
-= The Duct Framework
+= Duct
 James Reeves
 {docdate}
 :doctype: book
 :encoding: UTF-8
 :lang: en
-:source-highlighter: coderay
+:source-highlighter: highlight.js
+:highlightjs-theme: ir-black
+:highlightjs-languages: clojure, clojure-repl, json, shell
 :sectnums:
+:linkcss:
+:stylesheet: reset.css
 :toc: left
+:title: The Duct Framework
 :url-repo: https://github.com/duct-framework/duct-framework.github.io
 :experimental:
 :docinfo: shared
 
+[discrete]
+= The Duct Framework
+
 == Introduction
 
 Duct is a framework for developing server-side applications in the
@@ -215,7 +223,7 @@ user=>
 In the REPL environment the system will not be initiated automatically.
 Instead, we use the inbuilt `(go)` function.
 
-[,clojure]
+[,clojure-repl]
 ----
 user=> (go)
 Hello World
@@ -226,7 +234,7 @@ The REPL can be left running while source files updated. The `(reset)`
 function will halt the running system, reload any modified source files,
 then initiate the system again.
 
-[,clojure]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading (tutorial.print)
@@ -239,7 +247,7 @@ You can also use the kbd:[Alt-E] hotkey instead of typing `(reset)`.
 The configuration defined by `duct.edn` can be accessed with `config`,
 and the running system can be accessed with `system`.
 
-[,clojure]
+[,clojure-repl]
 ----
 user=> config
 #:tutorial.print{:hello {}}
@@ -509,7 +517,7 @@ $ duct --main
 
 But when using the REPL, we get a more concise message.
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (go)
 :initiated
@@ -806,9 +814,9 @@ we have no routes defined. The error page will be in plaintext, because
 we haven't specified what _features_ we want for our web application.
 
 We'll fix both these issues, but before we do we should terminate the
-application with Ctrl-C and start a REPL. We'll keep this running while
-we develop the application to avoid costly restarts and to give us a way
-of querying the running system.
+application with kbd:[Ctrl-C] and start a REPL. We'll keep this running
+while we develop the application to avoid costly restarts and to give
+us a way of querying the running system.
 
 [,shell]
 ----
@@ -859,7 +867,7 @@ returns a Hiccup data structure.
 
 Finally, we trigger a `(reset)` at the REPL.
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading (todo.routes)
@@ -1118,7 +1126,7 @@ Our project dependencies should now look like this:
 We can load these new dependencies either by restarting the REPL, or by
 using the `sync-deps` function.
 
-[,clojure]
+[,clojure-repl]
 ----
 user=> (sync-deps)
 [...]
@@ -1139,7 +1147,7 @@ The next step is to add `:duct.module/sql` to our Duct configuration.
 
 Then reset via the REPL:
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading ()
@@ -1174,7 +1182,7 @@ used in development.
 If we want to change this in production, we can use the corresponding
 command-line argument or environment variable to override this default.
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading ()
@@ -1277,7 +1285,7 @@ create a table to store the todo list items.
 
 When we reset the REPL, the migration is automatically applied.
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading (todo.routes)
@@ -1347,7 +1355,7 @@ combined with `execute!`.
 We can reset via the REPL and add some test data with the `sql`
 convenience function.
 
-[,shell]
+[,clojure-repl]
 ----
 user=> (reset)
 :reloading (todo.routes)
@@ -1965,6 +1973,7 @@ Once CIDER has connected, you can open a REPL with: kbd:[C-c] kbd:[C-z]
 This works in a similar way to the command-line REPL. To start up Duct,
 you can use the `(go)` command:
 
+[,clojure]
 ----
 user> (go)
 ----
@@ -2001,7 +2010,7 @@ print the expression, its value, and its location in your project.
 
 For example, at the REPL:
 
-[,clojure]
+[,clojure-repl]
 ----
 user=> (* 2 #p (+ 1 1))
 #p[user/eval11138:1] (+ 1 1) => 2
@@ -2021,7 +2030,7 @@ possible to use Duct with Leiningen.
 To do so, you'll need to update your project file with profile for Duct,
 and an alias to run it:
 
-.project
+.project.clj
 [,clojure]
 ----
 (defproject org.example/app "0.1.0-SNAPSHOT"
@@ -2069,6 +2078,7 @@ TIP: Use kbd:[Ctrl-Shift-P] to open the command palette.
 You'll be presented with a REPL where you can start the application
 with `(go)`
 
+[,clojure]
 ----
 clj꞉user꞉> (go)
 ----

index.adoc renamed to docs/index.adoc

@@ -0,0 +1,47 @@
+/*
+  Josh's Custom CSS Reset
+  https://www.joshwcomeau.com/css/custom-css-reset/
+*/
+
+*, *::before, *::after {
+  box-sizing: border-box;
+}
+
+* {
+  margin: 0;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  html {
+    interpolate-size: allow-keywords;
+  }
+}
+
+body {
+  line-height: 1.5;
+  -webkit-font-smoothing: antialiased;
+}
+
+img, picture, video, canvas, svg {
+  display: block;
+  max-width: 100%;
+}
+
+input, button, textarea, select {
+  font: inherit;
+}
+
+p, h1, h2, h3, h4, h5, h6 {
+  overflow-wrap: break-word;
+}
+
+p {
+  text-wrap: wrap;
+}
+h1, h2, h3, h4, h5, h6 {
+  text-wrap: balance;
+}
+
+#root, #__next {
+  isolation: isolate;
+}