Skip to content

Commit 2ce6cbd

Browse files
show namespace example table nearer
1 parent ba22ccd commit 2ce6cbd

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,10 @@ and displayed with markdown like `;; ![caption](my-image.jpg)`.
6666
The first image on the page is used as a preview in the blog listing,
6767
unless a different image is listed in the metadata.
6868

69+
### Adding Visualizations
70+
6971
[Kindly](https://scicloj.github.io/kindly-noted/kindly) annotations are rendered as visualizations.
72+
You add code like this:
7073

7174
```clojure
7275
^kind/table
@@ -76,7 +79,11 @@ unless a different image is listed in the metadata.
7679
:many-others ["see the examples" "creative uses" "visual variety"]}
7780
```
7881

79-
### Preview a Webpage **(Optional, Recommended)**
82+
Then you can render the table interactively, and it will also be rendered in the final post.
83+
84+
See [Clay examples](https://scicloj.github.io/clay/clay_book.examples.html) to see what's possible.
85+
86+
### Preview your namespace as a Webpage **(Optional, Recommended)**
8087

8188
Clay is ready to interactively render your namespace as HTML, you just need to ask it to "Clay Make File".
8289

@@ -169,6 +176,12 @@ Only you will run the code locally (where you have secrets and large files avail
169176

170177
See [Some notebooks should only be run locally](https://clojurecivitas.github.io/scicloj/clay/skip_if_unchanged_example.html) for more detail.
171178

179+
### Styling and other features
180+
181+
Pages are rendered with [Quarto](https://quarto.org).
182+
To see what styling options are available, check the [Quarto HTML Reference](https://quarto.org/docs/reference/formats/html.html).
183+
Anything you can do there, you can do in your namespace comment markdown and namespace metadata annotation.
184+
172185
## Design
173186

174187
Align with Clojure's values: simplicity, community, and tooling that helps you think.
@@ -198,6 +211,15 @@ namespace.
198211
Use discretion to determine if the narrative is primarily about an artifact library, a concept, or an event.
199212
- Namespaces must consist of more than one segment.
200213

214+
#### Choosing a Namespace Examples
215+
216+
| Namespace | Description |
217+
|-------------------------------------------------------------------------|---------------------------------------------------------------|
218+
| `lambdaisland.kaocha.customization-tips-and-tricks` | Tips for fast iteration with Kaocha. |
219+
| `clojure.lazy-sequences.detailed-explanation-by-example` | In-depth example-driven guide to lazy sequences. |
220+
| `algorithms.graph.layout.force-directed-spring-simulation` | On force-directed graph layout algorithms (library-agnostic). |
221+
| `reagent.component-lifecycle.a-tale-of-life-death-and-rebirth` | A whimsical take on Reagent component lifecycles. |
222+
201223
#### Metadata and Navigation
202224

203225
It may feel unintuitive not to group related content (e.g. an author’s blog series) by directory or namespace.
@@ -211,15 +233,6 @@ This promotes flexibility at the cost of tidiness, but enables richer discovery
211233

212234
Differentiation between posts, pages, and presentations is by `type` metadata (a Quarto page type convention).
213235

214-
#### Examples
215-
216-
| Namespace | Description |
217-
|-------------------------------------------------------------------------|---------------------------------------------------------------|
218-
| `lambdaisland.kaocha.customization-tips-and-tricks` | Tips for fast iteration with Kaocha. |
219-
| `clojure.lazy-sequences.detailed-explanation-by-example` | In-depth example-driven guide to lazy sequences. |
220-
| `algorithms.graph.layout.force-directed-spring-simulation` | On force-directed graph layout algorithms (library-agnostic). |
221-
| `reagent.component-lifecycle.a-tale-of-life-death-and-rebirth` | A whimsical take on Reagent component lifecycles. |
222-
223236
### File system organization
224237

225238
| Directory | Description |

0 commit comments

Comments
 (0)