search

scicloj / clay

A REPL-friendly Clojure tool for notebooks and datavis
https://scicloj.github.io/clay/
Eclipse Public License 1.0
134 stars 13 forks source link

polish "get started" a little bit. #180

Closed whatacold closed 1 week ago

whatacold commented 1 week ago

Hey Daniel,

The "Get Started" looks a little confusing for newly comers, at least for me when I first came to it, so I think maybe we can polish it a little bit. Inspired by #176 , I feel like we can start from a bare clj command line and then gradually cover a file and even a project.

This is just a proposal, feel free to change whatever you think is not clear or inaccurate.

whatacold commented 1 week ago

Hmm, why does slides.clj get this name? It seems there is nothing about slides in it.

whatacold commented 1 week ago

Hmm, why does slides.clj get this name? It seems there is nothing about slides in it.

Ah, I see! We have to use it with quarto:

(clay/make! {:format [:quarto :revealjs]
               :source-path "notebooks/slides.clj"})

Then it's not suitable to put it in "Get Started" as an example I think.

daslu commented 1 week ago

@whatacold This is really helpful, what a fantastic intro. I think you are right about your comments.