@@ -26,22 +26,42 @@ See [About Clojure Civitas](https://clojurecivitas.github.io/about).
2626Your perspective matters.
2727Pull 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
3345Configure 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 `  ` .
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
4767clojure -M:clay -a [:markdown]
@@ -51,12 +71,11 @@ clojure -M:clay -a [:markdown]
5171quarto 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
6180To create a pull request
6281
@@ -65,6 +84,8 @@ To create a pull request
65843 . push the branch to your fork
66854 . 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
7091Add to or modify [ db.edn] ( quarto/db.edn )
0 commit comments