Skip to content

Commit 4417073

Browse files
update README preview instructions
1 parent 57c7ef3 commit 4417073

File tree

2 files changed

+14
-15
lines changed

2 files changed

+14
-15
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,25 +70,24 @@ unless a different image is listed in the metadata.
7070
:many-others ["see the examples" "creative uses" "visual variety"]}
7171
```
7272

73-
## Preview the Website **(Optional)**
73+
## Preview a Webpage **(Optional, Recommended)**
7474

7575
[Use Clay REPL commands](https://scicloj.github.io/clay/#setup) to visualize the namespace as you write.
76+
When using Clay interactively it renders directly to HTML for speed.
7677

77-
Building is delegated to Clay and Quarto.
78+
## Previewing the Website with Quarto **(Optional, Not Recommended)**
7879

79-
When using Clay interactively it renders directly to HTML for speed.
8080
The published site goes through a longer process of producing markdown then HTML.
81+
[Quarto](https://quarto.org/) is the markdown publishing tool.
8182

8283
```sh
83-
clojure -M:clay -a [:markdown]
84+
clojure -M:clay -A:markdown
8485
```
8586

8687
```sh
8788
quarto preview site
8889
```
8990

90-
[Quarto](https://quarto.org/) is the markdown publishing tool.
91-
9291
### Publish
9392

9493
Create a pull request:

clay.edn

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
{:base-target-path "temp"
2-
:base-source-path "src"
3-
:subdirs-to-sync ["src"]
4-
:keep-sync-root false
5-
:flatten-targets false
6-
:remote-repo {:git-url "https://github.com/ClojureCivitas/clojurecivitas.github.io"
7-
:branch "main"}
8-
:hide-info-line true
9-
:hide-ui-header true
1+
{:base-target-path "temp"
2+
:base-source-path "src"
3+
:subdirs-to-sync ["src"]
4+
:keep-sync-root false
5+
:flatten-targets false
6+
:remote-repo {:git-url "https://github.com/ClojureCivitas/clojurecivitas.github.io"
7+
:branch "main"}
8+
:hide-info-line true
9+
:hide-ui-header true
1010
:config/transform civitas.db/expand-authors
1111

1212
;; aliases

0 commit comments

Comments
 (0)