Skip to content

Commit 14748ed

Browse files
short note about preferring code
1 parent 9f7424f commit 14748ed

2 files changed

Lines changed: 29 additions & 14 deletions

File tree

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<img src="src/images/civitas-icon.svg" alt="Civitas Icon" align="right">
44

5-
Your scratchpad
5+
Think. Code. Share.
66

77
⚡ No setup – Clone this repo, make a new namespace, start coding.
88

@@ -12,7 +12,7 @@ Your scratchpad
1212

1313
🧠 Build shared knowledge – Your work becomes part of a community resource.
1414

15-
🧪 Use Clay – Your normal REPL workflow, but with tables, charts, markdown, and hiccup.
15+
🧪 Visualize – Your normal REPL workflow, but with tables, charts, markdown, and hiccup.
1616

1717
## Rationale
1818

@@ -21,21 +21,24 @@ Your scratchpad
2121

2222
See [About Clojure Civitas](https://clojurecivitas.github.io/about).
2323

24+
Why markdown in code? We value reproducible artifacts.
25+
2426
## Contributing
2527

2628
Your perspective matters.
2729
Pull Requests invited, that's the point!
2830

29-
### Creating posts and pages
31+
### Creating Posts and Pages
3032

3133
Add a Clojure namespace or markdown file in the [`/src`](src) folder.
3234

3335
Add metadata on your namespace to set the title, author, and tags.
3436

3537
```clojure
36-
^{:kindly/hide-code true ; don't show this code in the notebook
38+
^{:kindly/hide-code true ; don't render this code to the HTML document
3739
:clay {:title "About Civitas Metadata"
3840
:quarto {:author :my-unique-id
41+
:draft true ; remove to publish
3942
:type :post
4043
:date "2025-06-05"
4144
:category :clojure
@@ -60,9 +63,14 @@ unless a different image is listed in the metadata.
6063
:many-others ["see the examples" "creative uses" "visual variety"]}
6164
```
6265

63-
**Optional:** [Set up your editor with Clay shortcuts](https://scicloj.github.io/clay/#setup) to visualize the notebook as you write.
66+
## Preview the Website **(Optional)**
67+
68+
[Set up your editor with Clay REPL commands](https://scicloj.github.io/clay/#setup) to visualize the notebook as you write.
69+
70+
Building is delegated to Clay and Quarto.
6471

65-
**Optional:** Preview the final website.
72+
When using Clay interactively it render directly to HTML for speed.
73+
The published site goes through a longer process of producing markdown then HTML.
6674

6775
```sh
6876
clojure -M:clay -a [:markdown]
@@ -76,26 +84,28 @@ quarto preview site
7684

7785
### Publish
7886

79-
Merged pull requests are automatically shown on the website.
80-
81-
To create a pull request
87+
Create a pull request:
8288

8389
1. fork the repository
84-
2. make and commit changes in a new branch
90+
2. make changes in a new branch and commit them
8591
3. push the branch to your fork
86-
4. and then open a pull request on GitHub to propose merging your changes into the Civitas main branch.
92+
4. open a pull request
93+
94+
Your pull request will be reviewed to prevent abuse and then merged.
95+
Once merged, namespaces are automatically published to the website.
8796

8897
Please contact [@timothypratley](https://github.com/timothypratley) if you are having any difficulty submitting a notebook.
8998

90-
### See your page views
99+
### Check Your Page Views
91100

92101
Publicly available [page view analytics](https://clojurecivitas.goatcounter.com/) indicate how widely your notebook is being shared.
93102

94-
### Building the database
103+
### Editing the Civitas Explorer Database
95104

96105
An open effort to structure learning resources with meaningful connections.
97-
Add to or modify [db.edn](quarto/db.edn).
106+
Add to or modify [site/db.edn](site/db.edn).
98107
The goal is to create a database of resources for learning.
108+
See the [explorer](https://clojurecivitas.github.io/civitas/explorer.html).
99109

100110
## Design
101111

site/about.qmd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,8 @@ See the [Clojure Civitas Analytics Dashboard](https://clojurecivitas.goatcounter
8484

8585
Made with [Clay](https://scicloj.github.io/clay/).
8686
See the [README.md](https://github.com/ClojureCivitas/clojurecivitas.github.io/blob/main/README.md) in the repository for contribution guidelines and technical details.
87+
88+
## Why markdown in code?
89+
90+
We value reproducible artifacts.
91+
Start with code. Make it work. Then tell the story.

0 commit comments

Comments
 (0)