hd-garden 0.14.12 → 0.14.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/Makefile +1 -1
  2. package/app/api/admin/distribution/route.ts +4 -2
  3. package/app/blog/[...path]/page.tsx +4 -2
  4. package/app/columns/[column]/[...path]/page.tsx +4 -2
  5. package/app/components/GardenMediaGuide.tsx +11 -23
  6. package/app/components/GardenPlayer.tsx +25 -0
  7. package/app/components/HandbookView.tsx +5 -3
  8. package/app/components/MarkdownArticle.tsx +7 -2
  9. package/app/components/PostReadingView.tsx +3 -3
  10. package/app/garden-modules.d.ts +10 -2
  11. package/app/globals.css +58 -1
  12. package/app/lib/content-body.ts +20 -0
  13. package/app/lib/garden-docs-meta.ts +2 -0
  14. package/app/lib/markdown-plugins.ts +5 -0
  15. package/app/lib/remark-video-player.d.mts +10 -0
  16. package/app/lib/remark-video-player.mjs +70 -0
  17. package/app/rss.xml/route.ts +3 -2
  18. package/bin/garden.mjs +18 -78
  19. package/docs/handbook/components/compose.md +3 -1
  20. package/docs/handbook/components/diagrams/chart.md +38 -0
  21. package/docs/handbook/components/diagrams/code-walkthrough.md +38 -0
  22. package/docs/handbook/components/diagrams/columns-join.md +38 -0
  23. package/docs/handbook/components/diagrams/compare.md +38 -0
  24. package/docs/handbook/components/diagrams/converter.md +38 -0
  25. package/docs/handbook/components/diagrams/facets.md +38 -0
  26. package/docs/handbook/components/diagrams/fan-out.md +38 -0
  27. package/docs/handbook/components/diagrams/icon-rail.md +38 -0
  28. package/docs/handbook/components/diagrams/inspect-grid.md +38 -0
  29. package/docs/handbook/components/diagrams/lanes.md +38 -0
  30. package/docs/handbook/components/diagrams/layers.md +38 -0
  31. package/docs/handbook/components/diagrams/other.md +37 -0
  32. package/docs/handbook/components/diagrams/plan.md +38 -0
  33. package/docs/handbook/components/diagrams/previews/chart.svg +7 -0
  34. package/docs/handbook/components/diagrams/previews/code-walkthrough.svg +5 -0
  35. package/docs/handbook/components/diagrams/previews/columns-join.svg +6 -0
  36. package/docs/handbook/components/diagrams/previews/compare.svg +5 -0
  37. package/docs/handbook/components/diagrams/previews/converter.svg +6 -0
  38. package/docs/handbook/components/diagrams/previews/facets.svg +6 -0
  39. package/docs/handbook/components/diagrams/previews/fan-out.svg +8 -0
  40. package/docs/handbook/components/diagrams/previews/icon-rail.svg +5 -0
  41. package/docs/handbook/components/diagrams/previews/inspect-grid.svg +5 -0
  42. package/docs/handbook/components/diagrams/previews/lanes.svg +5 -0
  43. package/docs/handbook/components/diagrams/previews/layers.svg +6 -0
  44. package/docs/handbook/components/diagrams/previews/other.svg +6 -0
  45. package/docs/handbook/components/diagrams/previews/plan.svg +5 -0
  46. package/docs/handbook/components/diagrams/previews/sequence.svg +7 -0
  47. package/docs/handbook/components/diagrams/previews/stepper.svg +5 -0
  48. package/docs/handbook/components/diagrams/previews/steps.svg +7 -0
  49. package/docs/handbook/components/diagrams/previews/tabs.svg +6 -0
  50. package/docs/handbook/components/diagrams/previews/timeline.svg +5 -0
  51. package/docs/handbook/components/diagrams/previews/trace.svg +7 -0
  52. package/docs/handbook/components/diagrams/previews/tunable.svg +4 -0
  53. package/docs/handbook/components/diagrams/previews/two-row.svg +4 -0
  54. package/docs/handbook/components/diagrams/sequence.md +38 -0
  55. package/docs/handbook/components/diagrams/stepper.md +38 -0
  56. package/docs/handbook/components/diagrams/steps.md +38 -0
  57. package/docs/handbook/components/diagrams/tabs.md +38 -0
  58. package/docs/handbook/components/diagrams/timeline.md +38 -0
  59. package/docs/handbook/components/diagrams/trace.md +38 -0
  60. package/docs/handbook/components/diagrams/tunable.md +38 -0
  61. package/docs/handbook/components/diagrams/two-row.md +38 -0
  62. package/docs/handbook/components/diagrams.md +100 -0
  63. package/docs/handbook/components/link-card.md +1 -1
  64. package/docs/handbook/components.md +1 -0
  65. package/docs/handbook/en/components/compose.md +3 -1
  66. package/docs/handbook/en/components/diagrams/chart.md +40 -0
  67. package/docs/handbook/en/components/diagrams/code-walkthrough.md +40 -0
  68. package/docs/handbook/en/components/diagrams/columns-join.md +40 -0
  69. package/docs/handbook/en/components/diagrams/compare.md +40 -0
  70. package/docs/handbook/en/components/diagrams/converter.md +40 -0
  71. package/docs/handbook/en/components/diagrams/facets.md +40 -0
  72. package/docs/handbook/en/components/diagrams/fan-out.md +40 -0
  73. package/docs/handbook/en/components/diagrams/icon-rail.md +40 -0
  74. package/docs/handbook/en/components/diagrams/inspect-grid.md +40 -0
  75. package/docs/handbook/en/components/diagrams/lanes.md +40 -0
  76. package/docs/handbook/en/components/diagrams/layers.md +40 -0
  77. package/docs/handbook/en/components/diagrams/other.md +39 -0
  78. package/docs/handbook/en/components/diagrams/plan.md +40 -0
  79. package/docs/handbook/en/components/diagrams/sequence.md +40 -0
  80. package/docs/handbook/en/components/diagrams/stepper.md +40 -0
  81. package/docs/handbook/en/components/diagrams/steps.md +40 -0
  82. package/docs/handbook/en/components/diagrams/tabs.md +40 -0
  83. package/docs/handbook/en/components/diagrams/timeline.md +40 -0
  84. package/docs/handbook/en/components/diagrams/trace.md +40 -0
  85. package/docs/handbook/en/components/diagrams/tunable.md +40 -0
  86. package/docs/handbook/en/components/diagrams/two-row.md +40 -0
  87. package/docs/handbook/en/components/diagrams.md +100 -0
  88. package/docs/handbook/en/components/link-card.md +1 -1
  89. package/docs/handbook/en/components.md +1 -0
  90. package/docs/handbook/en/start.md +1 -1
  91. package/docs/handbook/en/workflow.md +2 -2
  92. package/docs/handbook/en/writing.md +82 -1
  93. package/docs/handbook/start.md +1 -1
  94. package/docs/handbook/workflow.md +2 -2
  95. package/docs/handbook/writing.md +82 -1
  96. package/editors/dist/{garden-typora-0.14.12.zip → garden-typora-0.14.13.zip} +0 -0
  97. package/editors/dist/typora/main.js +175 -175
  98. package/editors/dist/typora/manifest.json +1 -1
  99. package/editors/dist/typora/style.css +44 -6
  100. package/editors/dist/vscode/{garden-ui-0.14.12.vsix → garden-ui-0.14.13.vsix} +0 -0
  101. package/package.json +1 -1
  102. package/scripts/build-content.mjs +23 -8
  103. package/scripts/dev-server.mjs +30 -2
  104. package/scripts/fetch-embed.mjs +39 -27
  105. package/scripts/handbook-diagrams.mjs +434 -0
  106. package/scripts/link-assets.mjs +6 -0
  107. package/scripts/vinext-runtime.mjs +80 -0
  108. package/templates/site/Makefile +1 -1
  109. package/templates/site/Makefile.en +1 -1
  110. package/ui/compose/compose.css +43 -5
  111. package/ui/garden/markdown-links.mjs +8 -5
  112. package/ui/garden/picker-placement.mjs +106 -2
  113. package/ui/garden/player.mjs +286 -0
  114. package/ui/garden/rehype-keep-punctuation.mjs +87 -18
  115. package/ui/preview/dist/garden-ui.css +43 -5
  116. package/ui/preview/dist/garden-ui.esm.js +4 -4
  117. package/ui/preview/dist/garden-ui.iife.js +4 -4
  118. package/vite.config.ts +84 -23
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Chart"
3
+ navTitle: "Chart"
4
+ description: "Use this to turn numbers you already have into bars, lines, or shares"
5
+ section: diagrams
6
+ order: 131
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Chart](../../../components/diagrams/previews/chart.svg)
12
+
13
+ Use this to turn numbers you already have into bars, lines, or shares.
14
+
15
+ Do not invent data. If the result should change with an input, prefer a tunable chart.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Chart" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Chart" is the recommended starting point: Chart only real numbers from the material, and label the axes and units. Do not invent values
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Code walkthrough"
3
+ navTitle: "Code walkthrough"
4
+ description: "Use this to walk through code line by line: what runs, and what the variables are"
5
+ section: diagrams
6
+ order: 161
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Code walkthrough](../../../components/diagrams/previews/code-walkthrough.svg)
12
+
13
+ Use this to walk through code line by line: what runs, and what the variables are.
14
+
15
+ If you only need to show the code, use an ordinary code block. If the code is long, cut it to the key stretch first.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Code walkthrough" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Code walkthrough" is the recommended starting point: Walk a short, important stretch of code. Say which line is running and what the variables are at that moment. Do not change facts in the original code
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Join diagram"
3
+ navTitle: "Join diagram"
4
+ description: "Use this to show how two sides connect through a middle item"
5
+ section: diagrams
6
+ order: 11
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Join diagram](../../../components/diagrams/previews/columns-join.svg)
12
+
13
+ Use this to show how two sides connect through a middle item.
14
+
15
+ If there is no middle connection, do not force one.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Join diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Join diagram" is the recommended starting point: First name the two sides, how the middle item joins them, and which block is the focus
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Comparison diagram"
3
+ navTitle: "Comparison diagram"
4
+ description: "Use this to compare two or three options under the same conditions"
5
+ section: diagrams
6
+ order: 91
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Comparison diagram](../../../components/diagrams/previews/compare.svg)
12
+
13
+ Use this to compare two or three options under the same conditions.
14
+
15
+ If you are only listing traits and there is no shared condition, use an ordinary table or an aspect diagram.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Comparison diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Comparison diagram" is the recommended starting point: Compare only when there is a real shared condition. Keep each side's facts, and do not invent a winner or a ranking
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Conversion diagram"
3
+ navTitle: "Conversion diagram"
4
+ description: "Use this when one input should produce several results at once"
5
+ section: diagrams
6
+ order: 151
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Conversion diagram](../../../components/diagrams/previews/converter.svg)
12
+
13
+ Use this when one input should produce several results at once.
14
+
15
+ If there is only one result, use a tunable chart. If each result needs its own control, split them first.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Conversion diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Conversion diagram" is the recommended starting point: Keep the formulas and units for one input that yields several results. Do not invent conversions that are not in the material
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Aspect diagram"
3
+ navTitle: "Aspect diagram"
4
+ description: "Use this to show several aspects of one thing, with no required order"
5
+ section: diagrams
6
+ order: 41
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Aspect diagram](../../../components/diagrams/previews/facets.svg)
12
+
13
+ Use this to show several aspects of one thing, with no required order.
14
+
15
+ If there is no order, do not draw a flow. If you are not comparing options under the same conditions, do not use a comparison diagram.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Aspect diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Aspect diagram" is the recommended starting point: List a short name and a note for each aspect, and say whether the blocks have a strict order
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Fan-out diagram"
3
+ navTitle: "Fan-out diagram"
4
+ description: "Use this to show a first stop that then branches to several places at once"
5
+ section: diagrams
6
+ order: 21
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Fan-out diagram](../../../components/diagrams/previews/fan-out.svg)
12
+
13
+ Use this to show a first stop that then branches to several places at once.
14
+
15
+ If there is no real first stop and then a branch, do not draw a fan-out.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Fan-out diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Fan-out diagram" is the recommended starting point: First say who reaches whom, then which places are reached at once, and which place is the focus
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Illustrated list"
3
+ navTitle: "Illustrated list"
4
+ description: "Use this to explain independent items one by one"
5
+ section: diagrams
6
+ order: 61
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Illustrated list](../../../components/diagrams/previews/icon-rail.svg)
12
+
13
+ Use this to explain independent items one by one.
14
+
15
+ If the items have no order dependence, do not draw a flow, and do not write them as a checklist to follow.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Illustrated list" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Illustrated list" is the recommended starting point: Lead each independent note with an icon, and keep the title and body together. This is not a flow, so do not add sequence arrows
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Grid diagram"
3
+ navTitle: "Grid diagram"
4
+ description: "Use this to mark which cells in a two-dimensional structure matter, and why"
5
+ section: diagrams
6
+ order: 201
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Grid diagram](../../../components/diagrams/previews/inspect-grid.svg)
12
+
13
+ Use this to mark which cells in a two-dimensional structure matter, and why.
14
+
15
+ If this is an ordinary data table and no cell needs a special note, use an ordinary table.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Grid diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Grid diagram" is the recommended starting point: Present the two-dimensional structure as a grid, and point out the cells that need a special note and why. Do not force an ordinary table into a grid diagram
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Message sequence"
3
+ navTitle: "Message sequence"
4
+ description: "Use this to show who sent what to whom, and when"
5
+ section: diagrams
6
+ order: 111
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Message sequence](../../../components/diagrams/previews/lanes.svg)
12
+
13
+ Use this to show who sent what to whom, and when.
14
+
15
+ This is not a general modeling language, and it does not support arbitrary branches, loops, or automatic routing.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Message sequence" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Message sequence" is the recommended starting point: Name the participants and the direction and order of their messages from the source. Do not add branches or loops that are not in the source
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Layer diagram"
3
+ navTitle: "Layer diagram"
4
+ description: "Use this to show top-down layers that do not have to be walked in order"
5
+ section: diagrams
6
+ order: 31
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Layer diagram](../../../components/diagrams/previews/layers.svg)
12
+
13
+ Use this to show top-down layers that do not have to be walked in order.
14
+
15
+ Layers are not automatically a flow that must be walked in order.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Layer diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Layer diagram" is the recommended starting point: Name each layer, say which layers are the focus, and whether every request follows this order
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,39 @@
1
+ ---
2
+ title: "Other"
3
+ navTitle: "Other"
4
+ description: "Use this when no built-in figure fits, and you need to combine text and graphics freely"
5
+ section: diagrams
6
+ order: 211
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Other](../../../components/diagrams/previews/other.svg)
12
+
13
+ Use this when no built-in figure fits, and you need to combine text and graphics freely.
14
+
15
+ Do not treat the built-in list as a closed allowlist, and do not learn a new syntax for this.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ Other is not another ready-made template. When no built-in figure fits, or several kinds of content need to sit together, combine ordinary Markdown, safe HTML, and basic blocks such as cards, rows, columns, or steps in the same `garden compose` fence. The recommended brief is not a syntax lesson, and the list is not a closed allowlist.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please combine text and graphics freely in one garden compose fence, from the material and the communication goal I provide. When no built-in figure fits, or several kinds of content need to sit together, use ordinary Markdown / HTML and the existing building blocks.
26
+
27
+ My material:
28
+ - (paste the content, relationships, and source wording)
29
+
30
+ My goal:
31
+ - (what the reader should understand, and what the focus is)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn a new syntax or write CSS
36
+ - The built-in figures in the list are a starting point, not a closed allowlist; if no recipe fits, extract the real relationships and combine building blocks
37
+ - Do not limit the result to one ready-made template; mix ordinary Markdown, safe HTML, and basic blocks such as cards, rows, columns, or steps when needed
38
+ ```
39
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Checklist"
3
+ navTitle: "Checklist"
4
+ description: "Use this when the reader should follow items one by one and come back to check progress"
5
+ section: diagrams
6
+ order: 191
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Checklist](../../../components/diagrams/previews/plan.svg)
12
+
13
+ Use this when the reader should follow items one by one and come back to check progress.
14
+
15
+ If these are only conceptual stages, use a list or a step diagram. If the reader should watch state change between steps, use a stepper.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Checklist" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Checklist" is the recommended starting point: List the steps in the order the reader will follow, and keep the wording from the source. Do not force conceptual stages into to-dos
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Flow diagram"
3
+ navTitle: "Flow diagram"
4
+ description: "Use this to show the order in which something is done"
5
+ section: diagrams
6
+ order: 71
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Flow diagram](../../../components/diagrams/previews/sequence.svg)
12
+
13
+ Use this to show the order in which something is done.
14
+
15
+ Do not add arrows to unordered items, and do not shrink type to force a horizontal row on a narrow screen.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Flow diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Flow diagram" is the recommended starting point: Use arrows only when the source text has an order. Short stages can run left to right; long stages or a narrow screen should stack top to bottom
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Stepper"
3
+ navTitle: "Stepper"
4
+ description: "Use this when the reader should pause on a step and see how state changes"
5
+ section: diagrams
6
+ order: 171
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Stepper](../../../components/diagrams/previews/stepper.svg)
12
+
13
+ Use this when the reader should pause on a step and see how state changes.
14
+
15
+ If there are only two or three static stages, use a step diagram or a flow diagram.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Stepper" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Stepper" is the recommended starting point: Let the reader step through how state changes. If the stages are only static, use a step diagram instead
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````
@@ -0,0 +1,40 @@
1
+ ---
2
+ title: "Step diagram"
3
+ navTitle: "Step diagram"
4
+ description: "Use this to explain something step by step, with room for detail inside a step"
5
+ section: diagrams
6
+ order: 81
7
+ ---
8
+
9
+ <!-- Generated by scripts/handbook-diagrams.mjs. Do not edit by hand. -->
10
+
11
+ ![Schematic for Step diagram](../../../components/diagrams/previews/steps.svg)
12
+
13
+ Use this to explain something step by step, with room for detail inside a step.
14
+
15
+ This is not a time-scaled bar, not a checklist to follow, and not a stepper for watching state change.
16
+
17
+ Typora and VS Code / Cursor share this list. In the `/garden` picker, this row is the same figure and the same use case. Choosing it inserts a `garden compose` brief. Fill in your material and goal, then ask the AI to compile the post.
18
+
19
+ The built-in picker currently inserts that brief in Chinese. The English wording below is the same recommended brief, written for the English handbook so you can copy it when you write in English.
20
+
21
+ The recommended brief is a starting point, not a syntax lesson, and not the only valid form. You may still combine Markdown or safe HTML building blocks in the same `garden compose` fence.
22
+
23
+ ````markdown
24
+ ```garden compose
25
+ Please make a "Step diagram" diagram in garden compose from the material and the communication goal I provide.
26
+
27
+ My material:
28
+ - (paste the original items and wording to keep)
29
+
30
+ My goal:
31
+ - (what the reader should see at a glance)
32
+
33
+ Please:
34
+ - Organize only from the material; do not invent facts or conclusions
35
+ - Handle the graphic syntax, layout, and mobile reading yourself; do not ask me to learn tags or write CSS
36
+ - "Step diagram" is the recommended starting point: Use a step diagram to make the order clear, and expand detail inside a step when needed. Do not turn it into a to-do list or a stepper unless the material really is that
37
+ - A recommended figure is not the only valid form; you may still combine necessary Markdown / HTML building blocks in the same compose fence
38
+ - Do not start a different author fence or a new syntax; use only garden compose
39
+ ```
40
+ ````