Skip to content

Commit d88e5c4

Browse files
committed
add README to _tools/ documenting project scripts
1 parent b007ec6 commit d88e5c4

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

_tools/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Project Scripts (`_tools/`)
2+
3+
Utility scripts for the quarto-web project. Run with `quarto run` (TypeScript, R, Python, or Lua).
4+
5+
## Scripts
6+
7+
| Script | Language | Description |
8+
|--------|----------|-------------|
9+
| `publish-date.ts` | TypeScript | Set a blog post date to today and rename its directory to match |
10+
| `algolia-add-custom-attribute.ts` | TypeScript | Post-render hook: adds custom attributes to Algolia search index |
11+
| `reference.ts` | TypeScript | Generate reference documentation |
12+
| `reference-cli-generate-md.R` | R | Generate CLI reference markdown |
13+
| `gallery-screenshot.R` | R | Capture gallery screenshots |
14+
| `sort-gallery.R` | R | Sort gallery entries |
15+
| `release-notes.R` | R | Generate release notes content |
16+
| `snapshot-typst.ts` | TypeScript | Capture Typst document snapshots as PNG |
17+
18+
## Usage
19+
20+
```bash
21+
# Run any script
22+
quarto run _tools/<script> [args]
23+
24+
# Examples
25+
quarto run _tools/publish-date.ts docs/blog/posts/2026-04-10-my-post
26+
quarto run _tools/snapshot-typst.ts source.qmd dest.png
27+
```
28+
29+
TypeScript scripts use the Deno runtime bundled with Quarto (no external install needed). R scripts require R/Rscript on PATH.

0 commit comments

Comments
 (0)