Contents
Garden HandbookComponent referencegarden card

Component reference · card

Summarize a paper, repository, or module in a card with metadata and numbered takeaways.

← Component reference · Usage: card

1Examples

Code

```garden card
title: SQLite Write-Ahead Logging
url: https://www.sqlite.org/wal.html
meta: Documentation · sqlite.org
description: Appends changes sequentially to a write-ahead log while readers continue reading the original database pages, reducing read-write contention.
points:
  - Writes append to the end of the `-wal` file instead of overwriting database pages in place on commit.
  - Readers record the current end-of-log mark to see a consistent snapshot without blocking concurrent writers.
  - Background checkpoints copy log pages back into the main database file in batches once a threshold is reached.
```

Preview

SQLite Write-Ahead Logging

Documentation · sqlite.org

Appends changes sequentially to a write-ahead log while readers continue reading the original database pages, reducing read-write contention.

  1. Writes append to the end of the -wal file instead of overwriting database pages in place on commit.

  2. Readers record the current end-of-log mark to see a consistent snapshot without blocking concurrent writers.

  3. Background checkpoints copy log pages back into the main database file in batches once a threshold is reached.

Code

```garden card
cards:
  - url: https://openlibrary.org/
    title: "Open Library: one page per book"
    description: An open catalogue run by the Internet Archive, with editions and e-book loans.
    image: /images/garden/ref-card-book.svg
    alt: A closed book
    source:
      - https://openlibrary.org/
    takeaway: "**Worth borrowing:** link the book's page when you pick, so everyone reads the same edition."
  - url: https://www.gutenberg.org/
    title: "Project Gutenberg: public-domain e-books"
    description: E-books that have entered the public domain, free to download.
    image: /images/garden/ref-card-lamp.svg
    alt: A desk lamp
    source:
      - https://www.gutenberg.org/
      - https://en.wikipedia.org/wiki/Project_Gutenberg
    takeaway: "**Worth borrowing:** pick a public-domain book now and then, so people without a copy can join at once."
```

Preview

2Syntax

```garden card
title:        # recommended, heading
url:          # optional, heading link
meta:         # optional, subtitle
description:  # summary (or text)
points:       # key points (or items)
image:        # optional, thumbnail
alt:          # optional, alt text
source:       # optional, source URL
site:         # optional, site name
takeaway:     # optional, takeaway
cards:        # multi-card mode, same keys
  - url:      # card link
```

3Fields

Fence header: ```garden card (snippet trigger ;gcard). Place fields at the top level for a single card, or pass a cards array for multiple horizontal row cards; invalid YAML or unknown top-level keys report garden-yaml on the block.

FieldRequiredDefaultAllowed Values & LimitsDescription
titleRecommendedurlstringCard heading; falls back to url if omitted
urlOptional""full https:// or http:// URLExternal link on the heading; renders title as plain text if omitted
metaOptionalnonestringSubtitle or metadata line below the heading
descriptionOne of description, points, or cards""string (alias text)Summary paragraph supporting inline bold and code
pointsOne of points, description, or cards[]string[] or { title, text? }[] (alias items; 2 to 4 points recommended, not checked)Numbered list of takeaways below the summary
imageOptionalnoneimage path or Data URLCard thumbnail
altOptionaltitlestringThumbnail alt text
sourceOptionalnoneURL, { url, site?, icon? }, or arraySource chip appended to description; multiple sources collapse to the first domain plus +N (such as gutenberg.org +1). icon defaults to the build-time downloaded favicon, then the uppercase first letter of the registrable domain's main label (e.g. en.wikipedia.org uses W, bbc.co.uk uses B)
siteOptionalhostname of url without www.stringDisplay name for the source site
takeawayOptionalnonestringOne-line takeaway separated by a top border at the bottom of the card (e.g. "**Worth borrowing:** ...")
cardsRequired for multi-card modenoneobject[]Stack of horizontal row cards, each supporting url, title, description (or text), image, alt, meta, source, and takeaway

4Limits & errors

  • Apart from the shared garden-yaml, this component has no error codes of its own; values marked "not checked" in the table never report an error.
Contents