Skip to content

Commit 8c1532b

Browse files
mark drafts for unfinished notebooks
1 parent a9937d8 commit 8c1532b

File tree

9 files changed

+40
-14
lines changed

9 files changed

+40
-14
lines changed

README.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,22 +26,42 @@ See [About Clojure Civitas](https://clojurecivitas.github.io/about).
2626
Your perspective matters.
2727
Pull Requests invited, that's the point!
2828

29-
### Write notebooks
29+
### Creating notebooks
3030

31-
Add a notebook (Clojure namespace or markdown file) in the [`/notebooks`](notebooks) folder.
31+
Add a Clojure namespace or markdown file in the [`/notebooks`](notebooks) folder.
32+
33+
Add metadata on your namespace to set the title, author, and tags.
34+
```clojure
35+
^{:kindly/hide-code true ; don't show this code in the notebook
36+
:clay {:title "About Civitas Metadata"
37+
:quarto {:author :my-unique-id
38+
:type :post
39+
:date "2025-06-05"
40+
:category :clojure
41+
:tags [:metadata :civitas]}}}
42+
(ns my.namespace.example)
43+
```
3244

3345
Configure your author profile in [clay.edn](clay.edn).
3446

35-
**Optional:** Use [Kindly](https://scicloj.github.io/kindly-noted/kindly) annotations in your notebook to make visualizations
47+
Images can be added to the same folder as the namespace,
48+
and displayed in the notebook with markdown like `![caption](my-image.jpg)`.
49+
The first image on the page is used as a preview in the blog listing,
50+
unless a different image is listed in the metadata.
51+
52+
[Kindly](https://scicloj.github.io/kindly-noted/kindly) annotations in your notebook are rendered as visualizations.
3653

3754
```clojure
38-
^kind/hiccup
39-
[:svg [:circle {:r 50}]]
55+
^kind/table
56+
{:tables ["clean layout" "easy to scan" "communicates clearly"]
57+
:charts ["information-dense" "reveals insights" "pattern-focused"]
58+
:hiccup ["build anything" "custom layouts" "unlimited flexibility"]
59+
:many-others ["see the examples" "creative uses" "visual variety"]}
4060
```
4161

42-
**Optional:** Use [Clay](https://scicloj.github.io/clay/#setup) to visualize the notebook as you write it.
62+
**Optional:** [Setup your editor with Clay shortcuts](https://scicloj.github.io/clay/#setup) to visualize the notebook as you write.
4363

44-
**Optional:** Preview the final website
64+
**Optional:** Preview the final website.
4565

4666
```sh
4767
clojure -M:clay -a [:markdown]
@@ -51,12 +71,11 @@ clojure -M:clay -a [:markdown]
5171
quarto preview site
5272
```
5373

54-
[Quarto](https://quarto.org/) is a markdown publishing tool that enhances
55-
[Pandoc](https://pandoc.org/).
74+
[Quarto](https://quarto.org/) is the markdown publishing tool.
5675

5776
### Publish
5877

59-
Merged pull requests are shown on the website via a workflow.
78+
Merged pull requests are automatically shown on the website.
6079

6180
To create a pull request
6281

@@ -65,6 +84,8 @@ To create a pull request
6584
3. push the branch to your fork
6685
4. and then open a pull request on GitHub to propose merging your changes into the Civitas main branch.
6786

87+
Please contact @timothypratley if you are having any difficulty submitting a notebook.
88+
6889
### Building the database
6990

7091
Add to or modify [db.edn](quarto/db.edn)

notebooks/clojure+/print/objects_and_protocols.clj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
^{:kindly/hide-code true
2-
:clay {:title "Printing Objects in Clojure"
2+
:clay {:title "Printing Objects and Protocols in Clojure"
3+
:draft true
34
:type :post
45
:date "2025-06-09"
56
:quarto {:author :timothypratley}}}

notebooks/clojure/print_object/remove_extraneous.clj

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
(ns clojure.print-object.remove-extraneous
99
(:require [clojure.core.async :as async]
1010
[clojure.string :as str])
11-
(:import (clojure.lang MultiFn)
12-
(java.io Writer)))
11+
(:import (java.io Writer)))
1312

1413
^:kindly/hide-code ^:kind/hidden
1514
(set! *warn-on-reflection* true)

notebooks/core/async/flow/exploration.clj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:clay {:title "Core Async Flow Exploration"
33
:quarto {:author [:daslu :timothypratley]
44
:type :post
5+
:draft true
56
:date "2025-05-16"
67
:category :clojure
78
:tags [:core.async :core.async.flow]}}}

notebooks/core/async/flow/visualization.clj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:clay {:title "Core Async Flow Visualization"
33
:quarto {:author [:daslu :timothypratley]
44
:type :post
5+
:draft true
56
:date "2025-05-17"
67
:category :clojure
78
:tags [:core.async :core.async.flow]}}}

notebooks/core/async/flow/visualization/flow_elk.clj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
^{:kindly/hide-code true
22
:clay {:quarto {:title "Flow to ELK data transformation"
33
:author :timothypratley
4+
:draft true
45
:category :clojure
56
:tags [:core.async :core.async.flow]}}}
67

notebooks/graph/layout/elk.clj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
^{:kindly/hide-code true
22
:clay {:title "Eclipse Layout Kernel"
33
:quarto {:author :timothypratley
4+
:draft true
45
:category :clojure
56
:tags [:graphs :graph-layout]}}}
67
(ns graph.layout.elk

notebooks/graph/layout/elk_svg.clj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
^{:clay {:title "ELK SVG"
22
:quarto {:author :timothypratley
3+
:draft true
34
:category :clojure
45
:tags [:graphs :svg :visualization]}}}
56
(ns graph.layout.elk-svg

notebooks/scicloj/noj/intro/getting-started-noj.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Hello code champs, number ninjas and data divers!
1414

1515
Imagine being able to experiment with Clojure without needing to install tooling, set up editors, or even know about deps.edn
1616
Sounds like a dream, right?
17-
Well, dream no more—meet Noj's new Code Reload Executable!
17+
Well, dream no more—meet [Noj's](https://scicloj.github.io/noj/) new Code Reload Executable!
1818

1919
![Noj](Noj-icon.svg)
2020

0 commit comments

Comments
 (0)