11# Clojure Civitas
22
3- <img src =" notebooks /images/civitas-icon.svg" alt =" Civitas Icon " align =" right " >
3+ <img src =" src /images/civitas-icon.svg" alt =" Civitas Icon " align =" right " >
44
55An open effort to structure learning resources with meaningful connections.
66
77⚡ No setup – Clone this repo, make a new namespace, start coding.
88
99✍️ Write as you code – Capture notes, results, and ideas as you go as comments.
1010
11- 🚀 Easy to share – Create a Pull Request, once merged it appears on the [ Clojure Civitas Website] ( https://clojurecivitas.github.io ) .
11+ 🚀 Easy to share – Create a Pull Request, once merged it appears on
12+ the [ Clojure Civitas Website] ( https://clojurecivitas.github.io ) .
1213
1314🧠 Build shared knowledge – Your work becomes part of a community resource.
1415
@@ -26,11 +27,12 @@ See [About Clojure Civitas](https://clojurecivitas.github.io/about).
2627Your perspective matters.
2728Pull Requests invited, that's the point!
2829
29- ### Creating notebooks
30+ ### Creating posts and pages
3031
31- Add a Clojure namespace or markdown file in the [ ` /notebooks ` ] ( notebooks ) folder.
32+ Add a Clojure namespace or markdown file in the [ ` /src ` ] ( src ) folder.
3233
3334Add metadata on your namespace to set the title, author, and tags.
35+
3436``` clojure
3537^{:kindly/hide-code true ; don't show this code in the notebook
3638 :clay {:title " About Civitas Metadata"
@@ -59,7 +61,8 @@ unless a different image is listed in the metadata.
5961 :many-others [" see the examples" " creative uses" " visual variety" ]}
6062```
6163
62- ** Optional:** [ Setup your editor with Clay shortcuts] ( https://scicloj.github.io/clay/#setup ) to visualize the notebook as you write.
64+ ** Optional:** [ Setup your editor with Clay shortcuts] ( https://scicloj.github.io/clay/#setup ) to visualize the notebook
65+ as you write.
6366
6467** Optional:** Preview the final website.
6568
@@ -84,11 +87,13 @@ To create a pull request
84873 . push the branch to your fork
85884 . and then open a pull request on GitHub to propose merging your changes into the Civitas main branch.
8689
87- Please contact [ @timothypratley ] ( https://github.com/timothypratley ) if you are having any difficulty submitting a notebook.
90+ Please contact [ @timothypratley ] ( https://github.com/timothypratley ) if you are having any difficulty submitting a
91+ notebook.
8892
8993### See your page views
9094
91- Publicly available [ page view analytics] ( https://clojurecivitas.goatcounter.com/ ) indicate how widely your notebook is being shared.
95+ Publicly available [ page view analytics] ( https://clojurecivitas.goatcounter.com/ ) indicate how widely your notebook is
96+ being shared.
9297
9398### Building the database
9499
@@ -160,19 +165,18 @@ Differentiation between posts, pages, and presentations is by `type` metadata (a
160165
161166### File system organization
162167
163- | Directory | Description |
164- | -------------| ----------------------------------------------------------------------|
165- | ` src ` | Code for building a website and database |
166- | ` notebooks ` | Source root for notebooks (Clojure and Markdown), images, data files |
167- | ` site ` | Static assets of the Quarto website |
168+ | Directory | Description |
169+ | -----------| ----------------------------------------------------------------------|
170+ | ` src ` | Source root for notebooks (Clojure and Markdown), images, data files |
171+ | ` site ` | Static assets of the Quarto website |
168172
169- Non-Clojure files in ` notebooks ` will be synced to ` site ` .
170- Shared images can go in ` images ` , but prefer placing images and data files as siblings to your namespace under
171- ` notebooks ` .
172- All Clojure and Non-Clojure files in ` notebooks ` should go under a subdirectory,
173+ Non-Clojure files in ` src ` will be synced to ` site ` .
174+ Shared images can go in ` src/ images` ,
175+ but prefer placing images and data files as siblings to your namespace under ` src ` .
176+ All files in ` src ` should go under a subdirectory,
173177so that it is clear they are not part of the static configuration of ` site ` .
174- When building the site, Clojure namespaces are built to markdown files under ` site/{my/namespaced/notebook.qmd} ` .
175- Subdirectories of ` site ` are gitignored and considered temporary build artifacts, safe to clean up.
178+ Clojure namespaces are built to markdown files under ` site/{my/namespaced/notebook.qmd} ` .
179+ Subdirectories of ` site ` are git ignored and considered temporary build artifacts, safe to clean up.
176180Quarto builds all the markdown into HTML in ` _site ` for preview and deploy.
177181While developing, Clay uses ` temp ` to build and serve HTML files.
178182
0 commit comments