@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.11

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 (1011) hide show
  1. package/AUTHORING.md +269 -0
  2. package/CHANGELOG.md +82 -0
  3. package/LICENSE +202 -0
  4. package/README.md +189 -2
  5. package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +33 -0
  6. package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
  7. package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +9 -0
  8. package/agent-docs/SNAPSHOT.json +9 -0
  9. package/agent-docs/about.md +49 -0
  10. package/agent-docs/api-docs/focused-contracts.md +68 -0
  11. package/agent-docs/api-docs/generate.md +189 -0
  12. package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
  13. package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
  14. package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
  15. package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
  16. package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
  17. package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
  18. package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
  19. package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
  20. package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
  21. package/agent-docs/api-docs/support.md +97 -0
  22. package/agent-docs/author/add-page.md +124 -0
  23. package/agent-docs/author/agent-overview.md +59 -0
  24. package/agent-docs/author/agent-workflow.md +65 -0
  25. package/agent-docs/author/agents.md +53 -0
  26. package/agent-docs/author/analytics.md +286 -0
  27. package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
  28. package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
  29. package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
  30. package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
  31. package/agent-docs/author/analytics.sections/event-format.md +59 -0
  32. package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
  33. package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
  34. package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
  35. package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
  36. package/agent-docs/author/analytics.sections/related-reading.md +42 -0
  37. package/agent-docs/author/authoring-agent.md +102 -0
  38. package/agent-docs/author/coding-agent.md +90 -0
  39. package/agent-docs/author/components/action-link.md +41 -0
  40. package/agent-docs/author/components/api-embeds.md +263 -0
  41. package/agent-docs/author/components/api-embeds.sections/apiexample.md +117 -0
  42. package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
  43. package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
  44. package/agent-docs/author/components/badge.md +76 -0
  45. package/agent-docs/author/components/breadcrumbs.md +57 -0
  46. package/agent-docs/author/components/callout.md +131 -0
  47. package/agent-docs/author/components/cards.md +168 -0
  48. package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
  49. package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
  50. package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
  51. package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
  52. package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
  53. package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
  54. package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
  55. package/agent-docs/author/components/code-blocks.md +117 -0
  56. package/agent-docs/author/components/collapsible.md +99 -0
  57. package/agent-docs/author/components/cookbook-chooser.md +86 -0
  58. package/agent-docs/author/components/custom/react.md +190 -0
  59. package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
  60. package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
  61. package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
  62. package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
  63. package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
  64. package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
  65. package/agent-docs/author/components/custom.md +183 -0
  66. package/agent-docs/author/components/definition-list.md +54 -0
  67. package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
  68. package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
  69. package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
  70. package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
  71. package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
  72. package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
  73. package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
  74. package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
  75. package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
  76. package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
  77. package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
  78. package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
  79. package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
  80. package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
  81. package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
  82. package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
  83. package/agent-docs/author/components/diagrams.md +155 -0
  84. package/agent-docs/author/components/doc-link.md +58 -0
  85. package/agent-docs/author/components/fields.md +121 -0
  86. package/agent-docs/author/components/file-tree.md +84 -0
  87. package/agent-docs/author/components/images.md +103 -0
  88. package/agent-docs/author/components/info-hint.md +61 -0
  89. package/agent-docs/author/components/kbd.md +45 -0
  90. package/agent-docs/author/components/math.md +39 -0
  91. package/agent-docs/author/components/only.md +65 -0
  92. package/agent-docs/author/components/progress.md +53 -0
  93. package/agent-docs/author/components/related-reading.md +48 -0
  94. package/agent-docs/author/components/steps.md +121 -0
  95. package/agent-docs/author/components/tables.md +64 -0
  96. package/agent-docs/author/components/tabs.md +129 -0
  97. package/agent-docs/author/components/timeline.md +74 -0
  98. package/agent-docs/author/components/tooltips.md +58 -0
  99. package/agent-docs/author/components/walkthroughs.md +390 -0
  100. package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
  101. package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
  102. package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
  103. package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
  104. package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
  105. package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
  106. package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +53 -0
  107. package/agent-docs/author/components.md +78 -0
  108. package/agent-docs/author/content.md +74 -0
  109. package/agent-docs/author/cookbooks.md +119 -0
  110. package/agent-docs/author/css.md +238 -0
  111. package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
  112. package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
  113. package/agent-docs/author/css.sections/page-attributes.md +69 -0
  114. package/agent-docs/author/css.sections/page-transitions.md +60 -0
  115. package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
  116. package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
  117. package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
  118. package/agent-docs/author/custom-metadata.md +177 -0
  119. package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
  120. package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
  121. package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
  122. package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
  123. package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
  124. package/agent-docs/author/design-templates.md +49 -0
  125. package/agent-docs/author/design-writing-guides.md +73 -0
  126. package/agent-docs/author/frontmatter-reference.md +146 -0
  127. package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
  128. package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
  129. package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
  130. package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
  131. package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
  132. package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
  133. package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
  134. package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
  135. package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
  136. package/agent-docs/author/frontmatter.md +255 -0
  137. package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
  138. package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
  139. package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
  140. package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
  141. package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
  142. package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
  143. package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
  144. package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
  145. package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
  146. package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
  147. package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
  148. package/agent-docs/author/markdown-metadata.md +207 -0
  149. package/agent-docs/author/navigation.md +269 -0
  150. package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
  151. package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
  152. package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
  153. package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
  154. package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
  155. package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
  156. package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
  157. package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
  158. package/agent-docs/author/navigation.sections/related-reading.md +44 -0
  159. package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
  160. package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
  161. package/agent-docs/author/reader-views.md +200 -0
  162. package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
  163. package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
  164. package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
  165. package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
  166. package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
  167. package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
  168. package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
  169. package/agent-docs/author/recipe-drafts.md +181 -0
  170. package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
  171. package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
  172. package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
  173. package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
  174. package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
  175. package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
  176. package/agent-docs/author/recipes.md +127 -0
  177. package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
  178. package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
  179. package/agent-docs/author/recipes.sections/related-reading.md +36 -0
  180. package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
  181. package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
  182. package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
  183. package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
  184. package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
  185. package/agent-docs/author/related-reading.md +143 -0
  186. package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
  187. package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
  188. package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
  189. package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
  190. package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
  191. package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
  192. package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
  193. package/agent-docs/author/release-notes.md +153 -0
  194. package/agent-docs/author/search.md +299 -0
  195. package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
  196. package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
  197. package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
  198. package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
  199. package/agent-docs/author/search.sections/lexical-search.md +78 -0
  200. package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
  201. package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
  202. package/agent-docs/author/search.sections/related-reading.md +45 -0
  203. package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
  204. package/agent-docs/author/search.sections/turn-search-off.md +46 -0
  205. package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
  206. package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
  207. package/agent-docs/author/snippets.md +118 -0
  208. package/agent-docs/author/taxonomy.md +121 -0
  209. package/agent-docs/author/templates.md +231 -0
  210. package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
  211. package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
  212. package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
  213. package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
  214. package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
  215. package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
  216. package/agent-docs/author/templates.sections/related-reading.md +47 -0
  217. package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
  218. package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
  219. package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
  220. package/agent-docs/author/workspace/commands.md +92 -0
  221. package/agent-docs/author/workspace.md +104 -0
  222. package/agent-docs/author/writing-style.md +137 -0
  223. package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
  224. package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +42 -0
  225. package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
  226. package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
  227. package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
  228. package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +41 -0
  229. package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
  230. package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
  231. package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
  232. package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
  233. package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
  234. package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
  235. package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
  236. package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
  237. package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
  238. package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
  239. package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
  240. package/agent-docs/changelog/2026-10-25.md +45 -0
  241. package/agent-docs/changelog/2026-10-26.md +66 -0
  242. package/agent-docs/changelog/2026-10-27.md +85 -0
  243. package/agent-docs/changelog/authoring-preview.md +40 -0
  244. package/agent-docs/changelog/authoring-search.md +39 -0
  245. package/agent-docs/changelog/authoring-tools.md +34 -0
  246. package/agent-docs/changelog/working-tree-skill.md +38 -0
  247. package/agent-docs/changelog.md +115 -0
  248. package/agent-docs/chat/checks.md +175 -0
  249. package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
  250. package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
  251. package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
  252. package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
  253. package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
  254. package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
  255. package/agent-docs/chat/checks.sections/related-reading.md +42 -0
  256. package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
  257. package/agent-docs/chat/host.md +222 -0
  258. package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
  259. package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
  260. package/agent-docs/chat/host.sections/related-reading.md +43 -0
  261. package/agent-docs/chat/passage-index.md +228 -0
  262. package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
  263. package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
  264. package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
  265. package/agent-docs/chat/passage-index.sections/limits.md +45 -0
  266. package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
  267. package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
  268. package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
  269. package/agent-docs/chat/prepared-answers.md +116 -0
  270. package/agent-docs/chat/settings.md +213 -0
  271. package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
  272. package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
  273. package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
  274. package/agent-docs/chat/settings.sections/related-reading.md +32 -0
  275. package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
  276. package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
  277. package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
  278. package/agent-docs/chat/setup.md +97 -0
  279. package/agent-docs/chat.md +102 -0
  280. package/agent-docs/cli.md +445 -0
  281. package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
  282. package/agent-docs/cli.sections/author-pages.md +94 -0
  283. package/agent-docs/cli.sections/build-and-serve.md +144 -0
  284. package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
  285. package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
  286. package/agent-docs/cli.sections/related-reading.md +33 -0
  287. package/agent-docs/cli.sections/search-and-chat.md +132 -0
  288. package/agent-docs/cli.sections/start-a-project.md +37 -0
  289. package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
  290. package/agent-docs/concepts.md +133 -0
  291. package/agent-docs/config/apis.md +136 -0
  292. package/agent-docs/config/content.md +264 -0
  293. package/agent-docs/config/content.sections/authoring.md +58 -0
  294. package/agent-docs/config/content.sections/badges.md +34 -0
  295. package/agent-docs/config/content.sections/callouts.md +34 -0
  296. package/agent-docs/config/content.sections/cookbooks.md +38 -0
  297. package/agent-docs/config/content.sections/frontmatter.md +75 -0
  298. package/agent-docs/config/content.sections/readerfilters.md +44 -0
  299. package/agent-docs/config/content.sections/related-reading.md +34 -0
  300. package/agent-docs/config/content.sections/relationships.md +76 -0
  301. package/agent-docs/config/content.sections/snippets.md +61 -0
  302. package/agent-docs/config/content.sections/templates.md +57 -0
  303. package/agent-docs/config/content.sections/variables.md +55 -0
  304. package/agent-docs/config/examples.md +354 -0
  305. package/agent-docs/config/examples.sections/feature-showcase.md +55 -0
  306. package/agent-docs/config/examples.sections/minimal-site.md +80 -0
  307. package/agent-docs/config/examples.sections/multilingual-help-center.md +110 -0
  308. package/agent-docs/config/examples.sections/parcel-api-documentation.md +153 -0
  309. package/agent-docs/config/examples.sections/related-reading.md +50 -0
  310. package/agent-docs/config/examples.sections/shared-company-preset.md +118 -0
  311. package/agent-docs/config/integrations.md +76 -0
  312. package/agent-docs/config/outputs.md +160 -0
  313. package/agent-docs/config/outputs.sections/exports.md +57 -0
  314. package/agent-docs/config/outputs.sections/metadata.md +42 -0
  315. package/agent-docs/config/outputs.sections/related-reading.md +34 -0
  316. package/agent-docs/config/publishing.md +219 -0
  317. package/agent-docs/config/publishing.sections/navigation.md +92 -0
  318. package/agent-docs/config/publishing.sections/redirects.md +79 -0
  319. package/agent-docs/config/publishing.sections/related-reading.md +33 -0
  320. package/agent-docs/config/site.md +193 -0
  321. package/agent-docs/config/site.sections/related-reading.md +33 -0
  322. package/agent-docs/config/site.sections/theme.md +74 -0
  323. package/agent-docs/config.md +195 -0
  324. package/agent-docs/configuration.md +384 -0
  325. package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
  326. package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
  327. package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
  328. package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
  329. package/agent-docs/configuration.sections/related-reading.md +42 -0
  330. package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
  331. package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
  332. package/agent-docs/configuration.sections/start-with-one-working-file.md +81 -0
  333. package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
  334. package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
  335. package/agent-docs/connect/mcp.md +85 -0
  336. package/agent-docs/contribute/agent-skills.md +72 -0
  337. package/agent-docs/cookbooks/authoring.md +68 -0
  338. package/agent-docs/cookbooks/site-workflows.md +59 -0
  339. package/agent-docs/cookbooks/welcome-email.md +55 -0
  340. package/agent-docs/documents.json +20058 -0
  341. package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
  342. package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
  343. package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
  344. package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
  345. package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
  346. package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
  347. package/agent-docs/example-api/cedar.md +39 -0
  348. package/agent-docs/example-api/create-note.md +344 -0
  349. package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
  350. package/agent-docs/example-api/write-note.md +55 -0
  351. package/agent-docs/explore.md +54 -0
  352. package/agent-docs/glossary.md +827 -0
  353. package/agent-docs/index.md +249 -0
  354. package/agent-docs/ingredients/audit-site.md +27 -0
  355. package/agent-docs/ingredients/build-site.md +29 -0
  356. package/agent-docs/ingredients/compile-framework.md +28 -0
  357. package/agent-docs/ingredients/complete-page.md +30 -0
  358. package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
  359. package/agent-docs/ingredients/inspect-build.md +41 -0
  360. package/agent-docs/ingredients/preview-site.md +31 -0
  361. package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
  362. package/agent-docs/ingredients/scaffold-page.md +28 -0
  363. package/agent-docs/non-goals.md +58 -0
  364. package/agent-docs/provenance.json +10 -0
  365. package/agent-docs/publish/agent-discovery.md +79 -0
  366. package/agent-docs/publish/agent-friendliness.md +201 -0
  367. package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
  368. package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
  369. package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
  370. package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
  371. package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
  372. package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
  373. package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
  374. package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
  375. package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
  376. package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
  377. package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
  378. package/agent-docs/publish/api-references.md +217 -0
  379. package/agent-docs/publish/api-references.sections/add-useful-examples.md +36 -0
  380. package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
  381. package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
  382. package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +36 -0
  383. package/agent-docs/publish/api-references.sections/generate-many-pages-selectively.md +36 -0
  384. package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
  385. package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +36 -0
  386. package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +36 -0
  387. package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
  388. package/agent-docs/publish/api-references.sections/publish-several-versions.md +36 -0
  389. package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
  390. package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
  391. package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
  392. package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
  393. package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +36 -0
  394. package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
  395. package/agent-docs/publish/audit.md +160 -0
  396. package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
  397. package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
  398. package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
  399. package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
  400. package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
  401. package/agent-docs/publish/audit.sections/related-reading.md +47 -0
  402. package/agent-docs/publish/content-export.md +208 -0
  403. package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
  404. package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
  405. package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
  406. package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
  407. package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
  408. package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
  409. package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
  410. package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
  411. package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
  412. package/agent-docs/publish/content-negotiation.md +121 -0
  413. package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
  414. package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
  415. package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
  416. package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
  417. package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
  418. package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
  419. package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
  420. package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
  421. package/agent-docs/publish/deployment-check.md +72 -0
  422. package/agent-docs/publish/evals.md +175 -0
  423. package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
  424. package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
  425. package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
  426. package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
  427. package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
  428. package/agent-docs/publish/evals.sections/related-reading.md +36 -0
  429. package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
  430. package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
  431. package/agent-docs/publish/host-adapters.md +60 -0
  432. package/agent-docs/publish/manni.md +227 -0
  433. package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
  434. package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
  435. package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
  436. package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
  437. package/agent-docs/publish/mcp-analytics.md +356 -0
  438. package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
  439. package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
  440. package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
  441. package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
  442. package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
  443. package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
  444. package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
  445. package/agent-docs/publish/mcp.md +190 -0
  446. package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
  447. package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
  448. package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
  449. package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
  450. package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
  451. package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
  452. package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
  453. package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
  454. package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
  455. package/agent-docs/publish/openapi-extension-mappings.md +84 -0
  456. package/agent-docs/publish/output.md +220 -0
  457. package/agent-docs/publish/output.sections/api-contracts.md +48 -0
  458. package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
  459. package/agent-docs/publish/output.sections/current-limits.md +40 -0
  460. package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
  461. package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
  462. package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
  463. package/agent-docs/publish/output.sections/page-formats.md +46 -0
  464. package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
  465. package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
  466. package/agent-docs/publish/output.sections/related-reading.md +34 -0
  467. package/agent-docs/publish/output.sections/response-identity.md +38 -0
  468. package/agent-docs/publish/output.sections/site-files.md +64 -0
  469. package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
  470. package/agent-docs/publish/output.sections/where-files-go.md +49 -0
  471. package/agent-docs/publish/publications.md +153 -0
  472. package/agent-docs/publish/revisions.md +104 -0
  473. package/agent-docs/publish/seo.md +119 -0
  474. package/agent-docs/publish/single-source-sites.md +168 -0
  475. package/agent-docs/publish/troubleshooting.md +112 -0
  476. package/agent-docs/publish/vercel.md +130 -0
  477. package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
  478. package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
  479. package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
  480. package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
  481. package/agent-docs/publish.md +95 -0
  482. package/agent-docs/recipes/add-page.md +194 -0
  483. package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
  484. package/agent-docs/recipes/add-page.sections/before-you-start.md +33 -0
  485. package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
  486. package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
  487. package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
  488. package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
  489. package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
  490. package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
  491. package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +42 -0
  492. package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
  493. package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
  494. package/agent-docs/recipes/audit-docs.md +122 -0
  495. package/agent-docs/recipes/build-docs.md +105 -0
  496. package/agent-docs/recipes/preview-hybrid-search.md +84 -0
  497. package/agent-docs/recipes/preview-page.md +124 -0
  498. package/agent-docs/recipes/queue-email.md +49 -0
  499. package/agent-docs/recipes/refresh-agent-docs.md +109 -0
  500. package/agent-docs/recipes/send-welcome-email.md +92 -0
  501. package/agent-docs/reference/agent-skills.md +73 -0
  502. package/agent-docs/search-and-chat.md +87 -0
  503. package/agent-docs/search-index.json +1 -0
  504. package/agent-docs/start.md +197 -0
  505. package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
  506. package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
  507. package/agent-docs/start.sections/build-this-site.md +35 -0
  508. package/agent-docs/start.sections/check-writing-style.md +35 -0
  509. package/agent-docs/start.sections/create-a-page.md +105 -0
  510. package/agent-docs/start.sections/make-it-yours.md +37 -0
  511. package/agent-docs/start.sections/prerequisites.md +37 -0
  512. package/agent-docs/start.sections/related-reading.md +45 -0
  513. package/agent-docs/start.sections/start-your-own-project.md +53 -0
  514. package/agent-docs/status.md +75 -0
  515. package/agent-docs/styling/color-modes.md +85 -0
  516. package/agent-docs/styling/footer.md +67 -0
  517. package/agent-docs/styling/header.md +65 -0
  518. package/agent-docs/styling/layouts.md +193 -0
  519. package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
  520. package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
  521. package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
  522. package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
  523. package/agent-docs/styling/layouts.sections/hero.md +83 -0
  524. package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
  525. package/agent-docs/styling/palettes.md +140 -0
  526. package/agent-docs/styling/share-images.md +105 -0
  527. package/agent-docs/styling/themes.md +125 -0
  528. package/agent-docs/styling/try.md +106 -0
  529. package/agent-docs/what-is-shoalrun.md +56 -0
  530. package/assets/analytics.js +72 -0
  531. package/assets/ask-widget.js +320 -0
  532. package/assets/code-samples.js +28 -0
  533. package/assets/components.js +32 -0
  534. package/assets/cookbook-chooser.js +170 -0
  535. package/assets/copy-markdown.js +24 -0
  536. package/assets/example-panel.js +77 -0
  537. package/assets/file-tree.js +49 -0
  538. package/assets/image-viewer.js +41 -0
  539. package/assets/mode.js +26 -0
  540. package/assets/navigation.js +233 -0
  541. package/assets/reader-filters.js +305 -0
  542. package/assets/reader.js +111 -0
  543. package/assets/search-highlight.js +32 -0
  544. package/assets/search-lexical.js +66 -0
  545. package/assets/search.js +150 -0
  546. package/assets/table-filter.js +63 -0
  547. package/assets/tabs.js +80 -0
  548. package/assets/theme-preview.css +17 -0
  549. package/assets/theme-preview.js +135 -0
  550. package/assets/theme-switcher.js +113 -0
  551. package/assets/tooltips.js +81 -0
  552. package/assets/walkthrough.js +233 -0
  553. package/dist/agent-discovery.d.ts +11 -0
  554. package/dist/agent-discovery.js +37 -0
  555. package/dist/analytics.d.ts +2 -0
  556. package/dist/analytics.js +13 -0
  557. package/dist/answer-cache.d.ts +24 -0
  558. package/dist/answer-cache.js +55 -0
  559. package/dist/answer-cards.d.ts +71 -0
  560. package/dist/answer-cards.js +148 -0
  561. package/dist/api-embeds.d.ts +22 -0
  562. package/dist/api-embeds.js +84 -0
  563. package/dist/api-identity.d.ts +6 -0
  564. package/dist/api-identity.js +7 -0
  565. package/dist/api-materialize.d.ts +12 -0
  566. package/dist/api-materialize.js +120 -0
  567. package/dist/api-publication-plan.d.ts +86 -0
  568. package/dist/api-publication-plan.js +187 -0
  569. package/dist/api-publication-review.d.ts +23 -0
  570. package/dist/api-publication-review.js +58 -0
  571. package/dist/api-selection.d.ts +21 -0
  572. package/dist/api-selection.js +84 -0
  573. package/dist/api.d.ts +74 -0
  574. package/dist/api.js +782 -0
  575. package/dist/artifact-bundle.d.ts +96 -0
  576. package/dist/artifact-bundle.js +306 -0
  577. package/dist/ask-function.d.ts +19 -0
  578. package/dist/ask-function.js +139 -0
  579. package/dist/ask-handler.d.ts +38 -0
  580. package/dist/ask-handler.js +157 -0
  581. package/dist/ask-log-kv.d.ts +14 -0
  582. package/dist/ask-log-kv.js +69 -0
  583. package/dist/ask-log.d.ts +106 -0
  584. package/dist/ask-log.js +159 -0
  585. package/dist/ask-setup.d.ts +43 -0
  586. package/dist/ask-setup.js +99 -0
  587. package/dist/ask.d.ts +152 -0
  588. package/dist/ask.js +532 -0
  589. package/dist/audit.d.ts +29 -0
  590. package/dist/audit.js +171 -0
  591. package/dist/authored-change.d.ts +22 -0
  592. package/dist/authored-change.js +47 -0
  593. package/dist/authoring-api.d.ts +18 -0
  594. package/dist/authoring-api.js +15 -0
  595. package/dist/authoring-findings.d.ts +31 -0
  596. package/dist/authoring-findings.js +104 -0
  597. package/dist/authoring-guidance.d.ts +15 -0
  598. package/dist/authoring-guidance.js +57 -0
  599. package/dist/authoring-preview.d.ts +24 -0
  600. package/dist/authoring-preview.js +160 -0
  601. package/dist/authoring-project-command.d.ts +7 -0
  602. package/dist/authoring-project-command.js +52 -0
  603. package/dist/authoring-project.d.ts +104 -0
  604. package/dist/authoring-project.js +287 -0
  605. package/dist/authoring-review-command.d.ts +1 -0
  606. package/dist/authoring-review-command.js +68 -0
  607. package/dist/authoring-review.d.ts +72 -0
  608. package/dist/authoring-review.js +71 -0
  609. package/dist/authoring-snapshot.d.ts +66 -0
  610. package/dist/authoring-snapshot.js +293 -0
  611. package/dist/authoring-validation-command.d.ts +1 -0
  612. package/dist/authoring-validation-command.js +54 -0
  613. package/dist/authoring-validation.d.ts +101 -0
  614. package/dist/authoring-validation.js +348 -0
  615. package/dist/badges.d.ts +16 -0
  616. package/dist/badges.js +57 -0
  617. package/dist/budget-store.d.ts +21 -0
  618. package/dist/budget-store.js +90 -0
  619. package/dist/budget.d.ts +45 -0
  620. package/dist/budget.js +128 -0
  621. package/dist/build-info.d.ts +10 -0
  622. package/dist/build-info.js +15 -0
  623. package/dist/callouts.d.ts +18 -0
  624. package/dist/callouts.js +63 -0
  625. package/dist/cards.d.ts +35 -0
  626. package/dist/cards.js +237 -0
  627. package/dist/chat-config.d.ts +117 -0
  628. package/dist/chat-config.js +400 -0
  629. package/dist/chat-pause.d.ts +1 -0
  630. package/dist/chat-pause.js +3 -0
  631. package/dist/chat.d.ts +46 -0
  632. package/dist/chat.js +78 -0
  633. package/dist/cli-discovery.d.ts +4 -0
  634. package/dist/cli-discovery.js +86 -0
  635. package/dist/cli.d.ts +2 -0
  636. package/dist/cli.js +750 -0
  637. package/dist/code-samples.d.ts +50 -0
  638. package/dist/code-samples.js +181 -0
  639. package/dist/compact-discovery.d.ts +15 -0
  640. package/dist/compact-discovery.js +78 -0
  641. package/dist/compiler-config.d.ts +67 -0
  642. package/dist/compiler-config.js +66 -0
  643. package/dist/compiler.d.ts +208 -0
  644. package/dist/compiler.js +524 -0
  645. package/dist/component-bundle.d.ts +4 -0
  646. package/dist/component-bundle.js +32 -0
  647. package/dist/component-content.d.ts +78 -0
  648. package/dist/component-content.js +47 -0
  649. package/dist/component-manifest.d.ts +15 -0
  650. package/dist/component-manifest.js +84 -0
  651. package/dist/component-names.d.ts +1 -0
  652. package/dist/component-names.js +1 -0
  653. package/dist/component-plugins.d.ts +28 -0
  654. package/dist/component-plugins.js +141 -0
  655. package/dist/component-transform.d.ts +10 -0
  656. package/dist/component-transform.js +697 -0
  657. package/dist/components.d.ts +2 -0
  658. package/dist/components.js +1 -0
  659. package/dist/config.d.ts +29 -0
  660. package/dist/config.js +149 -0
  661. package/dist/content-export-assets.d.ts +23 -0
  662. package/dist/content-export-assets.js +103 -0
  663. package/dist/content-export-command.d.ts +20 -0
  664. package/dist/content-export-command.js +57 -0
  665. package/dist/content-export-config.d.ts +16 -0
  666. package/dist/content-export-config.js +50 -0
  667. package/dist/content-export-render.d.ts +12 -0
  668. package/dist/content-export-render.js +132 -0
  669. package/dist/content-export.d.ts +30 -0
  670. package/dist/content-export.js +307 -0
  671. package/dist/content-filter.d.ts +4 -0
  672. package/dist/content-filter.js +16 -0
  673. package/dist/content-source.d.ts +100 -0
  674. package/dist/content-source.js +42 -0
  675. package/dist/content-workspace.d.ts +293 -0
  676. package/dist/content-workspace.js +69 -0
  677. package/dist/content.d.ts +41 -0
  678. package/dist/content.js +176 -0
  679. package/dist/cookbook-chooser.d.ts +19 -0
  680. package/dist/cookbook-chooser.js +56 -0
  681. package/dist/dev.d.ts +2 -0
  682. package/dist/dev.js +113 -0
  683. package/dist/diagram-svg.d.ts +1 -0
  684. package/dist/diagram-svg.js +44 -0
  685. package/dist/diagrams.d.ts +7 -0
  686. package/dist/diagrams.js +102 -0
  687. package/dist/docs-author.d.ts +86 -0
  688. package/dist/docs-author.js +380 -0
  689. package/dist/docs-command.d.ts +8 -0
  690. package/dist/docs-command.js +62 -0
  691. package/dist/docs-eval.d.ts +146 -0
  692. package/dist/docs-eval.js +231 -0
  693. package/dist/docs-mcp.d.ts +12 -0
  694. package/dist/docs-mcp.js +82 -0
  695. package/dist/docs-tool.d.ts +81 -0
  696. package/dist/docs-tool.js +7 -0
  697. package/dist/document-sync.d.ts +36 -0
  698. package/dist/document-sync.js +58 -0
  699. package/dist/documentation-core.d.ts +148 -0
  700. package/dist/documentation-core.js +160 -0
  701. package/dist/embeddings.d.ts +68 -0
  702. package/dist/embeddings.js +198 -0
  703. package/dist/focused-audit.d.ts +10 -0
  704. package/dist/focused-audit.js +69 -0
  705. package/dist/focused-openapi.d.ts +2 -0
  706. package/dist/focused-openapi.js +140 -0
  707. package/dist/fonts.d.ts +54 -0
  708. package/dist/fonts.js +92 -0
  709. package/dist/freshness.d.ts +7 -0
  710. package/dist/freshness.js +58 -0
  711. package/dist/frontmatter.d.ts +24 -0
  712. package/dist/frontmatter.js +342 -0
  713. package/dist/function-package.d.ts +1 -0
  714. package/dist/function-package.js +58 -0
  715. package/dist/highlight.d.ts +14 -0
  716. package/dist/highlight.js +114 -0
  717. package/dist/html-renderer.d.ts +10 -0
  718. package/dist/html-renderer.js +63 -0
  719. package/dist/icons.d.ts +8 -0
  720. package/dist/icons.js +40 -0
  721. package/dist/index-build.d.ts +55 -0
  722. package/dist/index-build.js +227 -0
  723. package/dist/ingredient-draft.d.ts +17 -0
  724. package/dist/ingredient-draft.js +94 -0
  725. package/dist/ingredient-workflow.d.ts +8 -0
  726. package/dist/ingredient-workflow.js +25 -0
  727. package/dist/init.d.ts +8 -0
  728. package/dist/init.js +66 -0
  729. package/dist/jev.d.ts +62 -0
  730. package/dist/jev.js +190 -0
  731. package/dist/link-audit.d.ts +12 -0
  732. package/dist/link-audit.js +146 -0
  733. package/dist/llms-discovery.d.ts +11 -0
  734. package/dist/llms-discovery.js +23 -0
  735. package/dist/markdown-sections.d.ts +15 -0
  736. package/dist/markdown-sections.js +60 -0
  737. package/dist/markdown-size.d.ts +7 -0
  738. package/dist/markdown-size.js +6 -0
  739. package/dist/mcp-analytics.d.ts +38 -0
  740. package/dist/mcp-analytics.js +35 -0
  741. package/dist/mcp-artifacts.d.ts +2 -0
  742. package/dist/mcp-artifacts.js +78 -0
  743. package/dist/mcp-client-metadata.d.ts +18 -0
  744. package/dist/mcp-client-metadata.js +69 -0
  745. package/dist/mcp-config.d.ts +23 -0
  746. package/dist/mcp-config.js +56 -0
  747. package/dist/mcp-http.d.ts +19 -0
  748. package/dist/mcp-http.js +157 -0
  749. package/dist/mcp-integrity.d.ts +3 -0
  750. package/dist/mcp-integrity.js +4 -0
  751. package/dist/mcp-node.d.ts +4 -0
  752. package/dist/mcp-node.js +68 -0
  753. package/dist/mcp-vercel-runtime.d.ts +3 -0
  754. package/dist/mcp-vercel-runtime.js +36 -0
  755. package/dist/mcp-vercel.d.ts +15 -0
  756. package/dist/mcp-vercel.js +65 -0
  757. package/dist/metadata-provider.d.ts +19 -0
  758. package/dist/metadata-provider.js +38 -0
  759. package/dist/negotiation.d.ts +10 -0
  760. package/dist/negotiation.js +35 -0
  761. package/dist/not-found.d.ts +16 -0
  762. package/dist/not-found.js +25 -0
  763. package/dist/output-commit.d.ts +1 -0
  764. package/dist/output-commit.js +133 -0
  765. package/dist/output-location.d.ts +3 -0
  766. package/dist/output-location.js +30 -0
  767. package/dist/page-materialization.d.ts +78 -0
  768. package/dist/page-materialization.js +132 -0
  769. package/dist/page-renderer.d.ts +71 -0
  770. package/dist/page-renderer.js +177 -0
  771. package/dist/palettes.d.ts +41 -0
  772. package/dist/palettes.js +160 -0
  773. package/dist/procedure-components.d.ts +2 -0
  774. package/dist/procedure-components.js +94 -0
  775. package/dist/project-navigation.d.ts +41 -0
  776. package/dist/project-navigation.js +190 -0
  777. package/dist/provider-http.d.ts +10 -0
  778. package/dist/provider-http.js +60 -0
  779. package/dist/publication-manifest.d.ts +229 -0
  780. package/dist/publication-manifest.js +53 -0
  781. package/dist/publication-plan.d.ts +34 -0
  782. package/dist/publication-plan.js +85 -0
  783. package/dist/publication-render.d.ts +71 -0
  784. package/dist/publication-render.js +92 -0
  785. package/dist/reader-filters.d.ts +30 -0
  786. package/dist/reader-filters.js +105 -0
  787. package/dist/recipe-draft.d.ts +17 -0
  788. package/dist/recipe-draft.js +147 -0
  789. package/dist/reference-audit.d.ts +18 -0
  790. package/dist/reference-audit.js +169 -0
  791. package/dist/remote-import.d.ts +62 -0
  792. package/dist/remote-import.js +292 -0
  793. package/dist/representation-tree.d.ts +3 -0
  794. package/dist/representation-tree.js +320 -0
  795. package/dist/retrieval-config.d.ts +30 -0
  796. package/dist/retrieval-config.js +83 -0
  797. package/dist/retrieval.d.ts +60 -0
  798. package/dist/retrieval.js +228 -0
  799. package/dist/scaffold.d.ts +39 -0
  800. package/dist/scaffold.js +167 -0
  801. package/dist/search-config.d.ts +8 -0
  802. package/dist/search-config.js +26 -0
  803. package/dist/search-handler.d.ts +16 -0
  804. package/dist/search-handler.js +111 -0
  805. package/dist/search-identifier.d.ts +3 -0
  806. package/dist/search-identifier.js +25 -0
  807. package/dist/search-literal.d.ts +1 -0
  808. package/dist/search-literal.js +28 -0
  809. package/dist/search-query.d.ts +54 -0
  810. package/dist/search-query.js +120 -0
  811. package/dist/search-results.d.ts +6 -0
  812. package/dist/search-results.js +45 -0
  813. package/dist/search-snippet.d.ts +11 -0
  814. package/dist/search-snippet.js +93 -0
  815. package/dist/search-synonyms.d.ts +8 -0
  816. package/dist/search-synonyms.js +46 -0
  817. package/dist/semantic-markdown.d.ts +10 -0
  818. package/dist/semantic-markdown.js +39 -0
  819. package/dist/server.d.ts +10 -0
  820. package/dist/server.js +223 -0
  821. package/dist/share-images.d.ts +24 -0
  822. package/dist/share-images.js +187 -0
  823. package/dist/site-path.d.ts +2 -0
  824. package/dist/site-path.js +15 -0
  825. package/dist/sitemap.d.ts +8 -0
  826. package/dist/sitemap.js +58 -0
  827. package/dist/snippets.d.ts +19 -0
  828. package/dist/snippets.js +84 -0
  829. package/dist/structured-model-output.d.ts +6 -0
  830. package/dist/structured-model-output.js +21 -0
  831. package/dist/subject-deprecation.d.ts +21 -0
  832. package/dist/subject-deprecation.js +57 -0
  833. package/dist/surface-text.d.ts +4 -0
  834. package/dist/surface-text.js +42 -0
  835. package/dist/taxonomy.d.ts +14 -0
  836. package/dist/taxonomy.js +88 -0
  837. package/dist/turnstile.d.ts +21 -0
  838. package/dist/turnstile.js +52 -0
  839. package/dist/vale.d.ts +28 -0
  840. package/dist/vale.js +103 -0
  841. package/dist/vercel-function.d.ts +21 -0
  842. package/dist/vercel-function.js +108 -0
  843. package/dist/vercel.d.ts +11 -0
  844. package/dist/vercel.js +103 -0
  845. package/dist/walkthrough.d.ts +25 -0
  846. package/dist/walkthrough.js +336 -0
  847. package/dist/yaml-value.d.ts +2 -0
  848. package/dist/yaml-value.js +36 -0
  849. package/example-configs/api-docs/README.md +59 -0
  850. package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
  851. package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
  852. package/example-configs/api-docs/content/overview.mdx +36 -0
  853. package/example-configs/api-docs/content/quickstart.mdx +52 -0
  854. package/example-configs/api-docs/docs.config.yaml +104 -0
  855. package/example-configs/faceted-sites/README.md +31 -0
  856. package/example-configs/faceted-sites/base.yaml +30 -0
  857. package/example-configs/faceted-sites/content/api.md +12 -0
  858. package/example-configs/faceted-sites/content/home.md +10 -0
  859. package/example-configs/faceted-sites/content/operations.md +12 -0
  860. package/example-configs/faceted-sites/developers.config.yaml +8 -0
  861. package/example-configs/faceted-sites/docs.config.yaml +7 -0
  862. package/example-configs/faceted-sites/europe.config.yaml +9 -0
  863. package/example-configs/minimal/content/install.mdx +12 -0
  864. package/example-configs/minimal/content/welcome.mdx +8 -0
  865. package/example-configs/minimal/docs.config.yaml +31 -0
  866. package/example-configs/multilingual/content/de/home.mdx +9 -0
  867. package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
  868. package/example-configs/multilingual/content/home.mdx +10 -0
  869. package/example-configs/multilingual/content/reset-password.mdx +12 -0
  870. package/example-configs/multilingual/docs.config.yaml +61 -0
  871. package/example-configs/multilingual/snippets/contact.mdx +1 -0
  872. package/example-configs/notifications/apis/notifications.yaml +132 -0
  873. package/example-configs/notifications/content/cookbook.mdx +17 -0
  874. package/example-configs/notifications/content/get-message.mdx +14 -0
  875. package/example-configs/notifications/content/queue-email.mdx +42 -0
  876. package/example-configs/notifications/content/queue-push.mdx +33 -0
  877. package/example-configs/notifications/content/queue-sms.mdx +33 -0
  878. package/example-configs/notifications/content/send-email.mdx +14 -0
  879. package/example-configs/notifications/content/send-push.mdx +14 -0
  880. package/example-configs/notifications/content/send-sms.mdx +14 -0
  881. package/example-configs/notifications/content/start.mdx +13 -0
  882. package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
  883. package/example-configs/notifications/content/welcome-email.mdx +82 -0
  884. package/example-configs/notifications/demo.mjs +43 -0
  885. package/example-configs/notifications/docs.config.yaml +88 -0
  886. package/example-configs/notifications/ingredient-drafts/README.md +41 -0
  887. package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
  888. package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
  889. package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
  890. package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
  891. package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
  892. package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
  893. package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
  894. package/example-configs/reference-stress/README.md +32 -0
  895. package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
  896. package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
  897. package/example-configs/reference-stress/content/overview.mdx +14 -0
  898. package/example-configs/reference-stress/docs.config.yaml +55 -0
  899. package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
  900. package/example-configs/shared-preset/shared/runbook.mdx +7 -0
  901. package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
  902. package/example-configs/shared-preset/site/content/start.mdx +9 -0
  903. package/example-configs/shared-preset/site/docs.config.yaml +18 -0
  904. package/example-configs/showcase/README.md +20 -0
  905. package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
  906. package/example-configs/showcase/content/assets/collection.svg +1 -0
  907. package/example-configs/showcase/content/code.mdx +100 -0
  908. package/example-configs/showcase/content/create-enrollment.mdx +11 -0
  909. package/example-configs/showcase/content/features.mdx +39 -0
  910. package/example-configs/showcase/content/landing.mdx +36 -0
  911. package/example-configs/showcase/content/overview.mdx +42 -0
  912. package/example-configs/showcase/content/personalization.mdx +38 -0
  913. package/example-configs/showcase/content/preview.mdx +35 -0
  914. package/example-configs/showcase/content/procedures.mdx +88 -0
  915. package/example-configs/showcase/content/quickstart.mdx +64 -0
  916. package/example-configs/showcase/content/reading.mdx +99 -0
  917. package/example-configs/showcase/content/verify.mdx +27 -0
  918. package/example-configs/showcase/content/visuals.mdx +47 -0
  919. package/example-configs/showcase/content/workflows.mdx +12 -0
  920. package/example-configs/showcase/docs.config.yaml +149 -0
  921. package/example-configs/showcase/snippets/sandbox.mdx +1 -0
  922. package/examples/analytics/README.md +56 -0
  923. package/examples/analytics/inspector.js +25 -0
  924. package/examples/analytics/posthog.js +36 -0
  925. package/examples/components/comparison.mjs +8 -0
  926. package/examples/components/components.json +6 -0
  927. package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
  928. package/examples/components/copy-text/LICENSE.react.txt +21 -0
  929. package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
  930. package/examples/components/copy-text/browser.jsx +21 -0
  931. package/examples/components/copy-text/components.json +6 -0
  932. package/examples/components/copy-text/package-lock.json +41 -0
  933. package/examples/components/copy-text/package.json +9 -0
  934. package/examples/components/copy-text/plugin.mjs +5 -0
  935. package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
  936. package/examples/components/retry-budget/LICENSE.react.txt +21 -0
  937. package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
  938. package/examples/components/retry-budget/browser.jsx +50 -0
  939. package/examples/components/retry-budget/components.json +6 -0
  940. package/examples/components/retry-budget/model.js +22 -0
  941. package/examples/components/retry-budget/package-lock.json +41 -0
  942. package/examples/components/retry-budget/package.json +9 -0
  943. package/examples/components/retry-budget/plugin.mjs +31 -0
  944. package/examples/components/retry-budget/policy.json +9 -0
  945. package/examples/components/retry-budget/style.css +25 -0
  946. package/examples/diagrams/d2-gallery.json +138 -0
  947. package/examples/diagrams/gallery.json +236 -0
  948. package/examples/help-drawer/README.md +44 -0
  949. package/examples/help-drawer/app.js +53 -0
  950. package/examples/help-drawer/components/components.json +1 -0
  951. package/examples/help-drawer/components/support.mjs +10 -0
  952. package/examples/help-drawer/content/account.md +8 -0
  953. package/examples/help-drawer/content/billing.mdx +29 -0
  954. package/examples/help-drawer/content/keys.mdx +46 -0
  955. package/examples/help-drawer/content/settings.svg +1 -0
  956. package/examples/help-drawer/docs.config.yaml +30 -0
  957. package/examples/help-drawer/index.html +26 -0
  958. package/examples/help-drawer/preview.mjs +33 -0
  959. package/examples/mcp-analytics/README.md +59 -0
  960. package/examples/mcp-analytics/posthog.mjs +159 -0
  961. package/package.json +100 -4
  962. package/schemas/content-export.schema.json +55 -0
  963. package/skills/shoalrun-author/SKILL.md +52 -0
  964. package/skills/shoalrun-component-author/SKILL.md +24 -0
  965. package/skills/shoalrun-recipes/SKILL.md +25 -0
  966. package/skills/shoalrun-setup/SKILL.md +34 -0
  967. package/skills/shoalrun-walkthrough/SKILL.md +18 -0
  968. package/styles/fonts/figtree-LICENSE.txt +93 -0
  969. package/styles/fonts/figtree-italic.woff2 +0 -0
  970. package/styles/fonts/figtree.woff2 +0 -0
  971. package/styles/fonts/inter-LICENSE.txt +93 -0
  972. package/styles/fonts/inter-italic.woff2 +0 -0
  973. package/styles/fonts/inter.woff2 +0 -0
  974. package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
  975. package/styles/fonts/jetbrains-mono.woff2 +0 -0
  976. package/styles/fonts/jost-LICENSE.txt +93 -0
  977. package/styles/fonts/jost-italic.woff2 +0 -0
  978. package/styles/fonts/jost.woff2 +0 -0
  979. package/styles/fonts/share/figtree-400.ttf +0 -0
  980. package/styles/fonts/share/figtree-700.ttf +0 -0
  981. package/styles/fonts/share/inter-400.ttf +0 -0
  982. package/styles/fonts/share/inter-700.ttf +0 -0
  983. package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
  984. package/styles/fonts/share/jost-italic-800.ttf +0 -0
  985. package/styles/fonts/share/metrics.json +1 -0
  986. package/styles/fonts/share/source-serif-4-400.ttf +0 -0
  987. package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
  988. package/styles/fonts/source-serif-4-italic.woff2 +0 -0
  989. package/styles/fonts/source-serif-4.woff2 +0 -0
  990. package/styles/header.css +56 -0
  991. package/styles/site.css +825 -0
  992. package/styles/themes/ledger.css +93 -0
  993. package/styles/themes/palettes/amethyst.yaml +127 -0
  994. package/styles/themes/palettes/coral.yaml +127 -0
  995. package/styles/themes/palettes/harbor.yaml +127 -0
  996. package/styles/themes/palettes/ink.yaml +127 -0
  997. package/styles/themes/palettes/kelp.yaml +127 -0
  998. package/styles/themes/palettes/vice.yaml +127 -0
  999. package/styles/themes/reef.css +68 -0
  1000. package/styles/themes/vice.css +56 -0
  1001. package/styles/tokens.css +91 -0
  1002. package/templates/api-reference.mdx +133 -0
  1003. package/templates/cookbook.mdx +38 -0
  1004. package/templates/explanation.mdx +76 -0
  1005. package/templates/guide.mdx +175 -0
  1006. package/templates/how-to.mdx +171 -0
  1007. package/templates/ingredient.mdx +53 -0
  1008. package/templates/recipe.mdx +76 -0
  1009. package/templates/reference.mdx +171 -0
  1010. package/templates/troubleshooting.mdx +159 -0
  1011. package/templates/tutorial.mdx +165 -0
package/dist/server.js ADDED
@@ -0,0 +1,223 @@
1
+ import { loadMcpRuntime, createMcpHttpHandler } from './mcp-http.js';
2
+ import { bridgeMcp } from './mcp-node.js';
3
+ import { notFoundPage, addNotFoundTwin } from './not-found.js';
4
+ import { createServer } from 'node:http';
5
+ import { readFile, realpath, stat } from 'node:fs/promises';
6
+ import path from 'node:path';
7
+ import { homeUrl, negotiatedDocument } from './negotiation.js';
8
+ const types = { '.html': 'text/html; charset=utf-8', '.md': 'text/markdown; charset=utf-8', '.xml': 'application/xml; charset=utf-8', '.json': 'application/json', '.yaml': 'application/yaml', '.yml': 'application/yaml', '.css': 'text/css; charset=utf-8', '.js': 'text/javascript; charset=utf-8', '.txt': 'text/plain; charset=utf-8', '.png': 'image/png', '.jpg': 'image/jpeg', '.jpeg': 'image/jpeg', '.svg': 'image/svg+xml', '.woff2': 'font/woff2', '.woff': 'font/woff', '.ttf': 'font/ttf', '.otf': 'font/otf' };
9
+ const bridgeLimit = 20_000;
10
+ // Read a Node request into a Web `Request`, refusing bodies over the limit before a handler sees them.
11
+ async function bridge(request, response, handler) {
12
+ const chunks = [];
13
+ let size = 0;
14
+ for await (const chunk of request) {
15
+ size += chunk.length;
16
+ if (size > bridgeLimit) {
17
+ response.writeHead(413, { 'Content-Type': 'application/json' });
18
+ response.end('{"error":"The request is too large."}');
19
+ return;
20
+ }
21
+ chunks.push(chunk);
22
+ }
23
+ const headers = new Headers();
24
+ for (const [name, value] of Object.entries(request.headers))
25
+ if (value !== undefined)
26
+ headers.set(name, Array.isArray(value) ? value.join(', ') : value);
27
+ const method = request.method ?? 'GET';
28
+ const result = await handler(new Request(`http://${request.headers.host ?? 'localhost'}${request.url ?? '/'}`, { method, headers, ...(method === 'GET' || method === 'HEAD' ? {} : { body: Buffer.concat(chunks) }) }));
29
+ // Headers.entries() joins repeated Set-Cookie values into one, which a browser reads as a single cookie. They are copied one by one.
30
+ for (const [name, value] of result.headers)
31
+ if (name !== 'set-cookie')
32
+ response.setHeader(name, value);
33
+ const cookies = result.headers.getSetCookie();
34
+ if (cookies.length)
35
+ response.setHeader('set-cookie', cookies);
36
+ response.writeHead(result.status);
37
+ response.end(Buffer.from(await result.arrayBuffer()));
38
+ }
39
+ export async function createSiteServer(directory, liveClients, extras = {}) {
40
+ const root = path.resolve(directory);
41
+ const realRoot = await realpath(root);
42
+ const loadState = async () => {
43
+ const headers = JSON.parse(await readFile(path.join(root, 'resource-headers.json'), 'utf8'));
44
+ const manifest = JSON.parse(await readFile(path.join(root, 'documents.json'), 'utf8'));
45
+ const redirects = JSON.parse(await readFile(path.join(root, 'redirects.json'), 'utf8').catch(() => '[]'));
46
+ const search = await siteFile(`${manifest.basePath ?? ''}/search-index.json`).then(file => stat(file)).then(info => info.isFile()).catch(() => false);
47
+ const errorHtml = await siteFile(`${manifest.basePath ?? ''}/404.html`).then(file => readFile(file, 'utf8')).catch(() => undefined);
48
+ return { headers, manifest, redirects, search, errorHtml, home: manifest.documents.find(item => item.url === manifest.basePath)?.url ?? homeUrl(manifest.documents), routes: new Set(manifest.documents.map(item => item.url)) };
49
+ };
50
+ const initialState = await loadState();
51
+ let mcp = await loadMcpRuntime(root);
52
+ let mcpHandler = mcp ? createMcpHttpHandler(mcp) : undefined;
53
+ let mcpBuild = mcp?.runtime.buildId;
54
+ async function siteFile(route) {
55
+ const file = path.resolve(root, `.${route}`);
56
+ if (file !== root && !file.startsWith(`${root}${path.sep}`))
57
+ throw new Error('Invalid path');
58
+ const realFile = await realpath(file);
59
+ if (realFile !== realRoot && !realFile.startsWith(`${realRoot}${path.sep}`))
60
+ throw new Error('Invalid path');
61
+ return file;
62
+ }
63
+ return createServer(async (request, response) => {
64
+ response.setHeader('X-Content-Type-Options', 'nosniff');
65
+ response.setHeader('Cache-Control', 'no-cache');
66
+ let pathname = '';
67
+ let recoveryState = initialState;
68
+ try {
69
+ pathname = decodeURIComponent(new URL(request.url ?? '/', 'http://localhost').pathname);
70
+ if (pathname.includes('\0') || pathname.split('/').includes('..'))
71
+ throw new Error('Invalid path');
72
+ const { headers, manifest, redirects, search, errorHtml, home, routes } = liveClients ? await loadState() : initialState;
73
+ recoveryState = { headers, manifest, redirects, search, errorHtml, home, routes };
74
+ const basePath = manifest.basePath ?? '';
75
+ if (liveClients && manifest.buildId !== mcpBuild) {
76
+ const next = await loadMcpRuntime(root);
77
+ mcp = next;
78
+ mcpHandler = next ? createMcpHttpHandler(next) : undefined;
79
+ mcpBuild = manifest.buildId;
80
+ }
81
+ const internalPath = pathname.toLowerCase().replace(/\/+$/, '');
82
+ if (internalPath === '/mcp-runtime.json' || internalPath === '/__shoalrun/mcp-data' || internalPath.startsWith('/__shoalrun/mcp-data/')) {
83
+ response.writeHead(404);
84
+ response.end();
85
+ return;
86
+ }
87
+ if (mcp && mcpHandler && pathname === mcp.runtime.path) {
88
+ await bridgeMcp(request, response, mcpHandler);
89
+ return;
90
+ }
91
+ if (liveClients && pathname === `${basePath}/__shoalrun/reload`) {
92
+ response.writeHead(200, { 'Content-Type': 'text/event-stream', 'Cache-Control': 'no-cache', Connection: 'keep-alive' });
93
+ response.write(': connected\n\n');
94
+ liveClients.add(response);
95
+ response.on('close', () => liveClients.delete(response));
96
+ return;
97
+ }
98
+ if (extras.ask && pathname === `${basePath}/__shoalrun/ask`) {
99
+ try {
100
+ await bridge(request, response, extras.ask);
101
+ }
102
+ catch {
103
+ if (!response.headersSent) {
104
+ response.writeHead(400, { 'Content-Type': 'application/json' });
105
+ response.end('{"error":"The request could not be read."}');
106
+ }
107
+ }
108
+ return;
109
+ }
110
+ if (extras.search && pathname === `${basePath}/__shoalrun/search`) {
111
+ try {
112
+ await bridge(request, response, extras.search);
113
+ }
114
+ catch {
115
+ if (!response.headersSent) {
116
+ response.writeHead(400, { 'Content-Type': 'application/json' });
117
+ response.end('{"error":"The request could not be read."}');
118
+ }
119
+ }
120
+ return;
121
+ }
122
+ // The public settings a hosted chat publishes. Serving them makes the panel run as the public chat instead of the local preview.
123
+ if (extras.ask && extras.publicSettings && pathname === `${basePath}/__shoalrun/chat.json`) {
124
+ response.writeHead(200, { 'Content-Type': 'application/json; charset=utf-8', 'Cache-Control': 'no-store' });
125
+ response.end(request.method === 'HEAD' ? undefined : JSON.stringify(extras.publicSettings));
126
+ return;
127
+ }
128
+ if (extras.ask && extras.widget && pathname === `${basePath}/__shoalrun/ask.js`) {
129
+ response.writeHead(200, { 'Content-Type': 'text/javascript; charset=utf-8', 'Cache-Control': 'no-store' });
130
+ // A local preview has no chat.json, so the panel wording from chat.panel is handed to the script directly.
131
+ response.end(request.method === 'HEAD' ? undefined : `${extras.panel ? `window.__shoalrunPanel=${JSON.stringify(extras.panel)};\n` : ''}${extras.widget}`);
132
+ return;
133
+ }
134
+ if ((pathname === '/' && !routes.has('/')) || (basePath && (pathname === basePath || pathname === `${basePath}/`) && !routes.has(basePath)))
135
+ if (home) {
136
+ response.writeHead(302, { Location: `${home}/` });
137
+ response.end();
138
+ return;
139
+ }
140
+ const redirectPath = pathname.replace(/(.)\/+$/, '$1');
141
+ const redirect = redirects.find(item => item.from === redirectPath);
142
+ const markdownRedirect = redirects.find(item => item.markdownTo && item.markdownFrom === pathname);
143
+ const location = redirect?.to ?? markdownRedirect?.markdownTo;
144
+ if (location) {
145
+ response.writeHead((redirect ?? markdownRedirect).status, { Location: location });
146
+ response.end();
147
+ return;
148
+ }
149
+ const sendRepresentation = (body, resourceHeaders) => {
150
+ const match = request.headers['if-none-match'];
151
+ const etag = resourceHeaders.ETag;
152
+ const notModified = (request.method === 'GET' || request.method === 'HEAD') && etag && match?.split(',').some(value => value.trim() === '*' || value.trim().replace(/^W\//, '') === etag);
153
+ response.writeHead(notModified ? 304 : 200, resourceHeaders);
154
+ response.end(notModified || request.method === 'HEAD' ? undefined : body);
155
+ };
156
+ const negotiated = negotiatedDocument(pathname, request.headers.accept, manifest.documents);
157
+ if (negotiated) {
158
+ const body = await readFile(await siteFile(negotiated.markdownUrl));
159
+ sendRepresentation(body, { ...headers[negotiated.markdownUrl], Vary: 'Accept', 'Content-Location': negotiated.markdownUrl, Link: [`<${negotiated.markdownUrl}>; rel="alternate"; type="text/markdown"`, headers[negotiated.markdownUrl]?.Link].filter(Boolean).join(', ') });
160
+ return;
161
+ }
162
+ let file = await siteFile(pathname);
163
+ const info = await stat(file);
164
+ if (info.isDirectory()) {
165
+ if (!pathname.endsWith('/')) {
166
+ response.writeHead(301, { Location: `${pathname}/${new URL(request.url ?? '/', 'http://localhost').search}`, ...(routes.has(pathname) ? { Vary: 'Accept' } : {}) });
167
+ response.end();
168
+ return;
169
+ }
170
+ file = await siteFile(path.posix.join(pathname, 'index.html'));
171
+ }
172
+ let body = await readFile(file);
173
+ const documentRoute = pathname === '/' ? '/' : pathname.replace(/\/+$/, '');
174
+ const document = manifest.documents.find(item => item.url === documentRoute);
175
+ const injected = `${liveClients ? `<script>const updates=new EventSource("${basePath}/__shoalrun/reload");updates.addEventListener("built",()=>location.reload());updates.addEventListener("failed",event=>{let status=document.getElementById("shoalrun-build-status");if(!status){status=document.createElement("aside");status.id="shoalrun-build-status";status.setAttribute("role","alert");document.body.append(status)}status.textContent="Build failed: "+JSON.parse(event.data).message})</script>` : ''}${extras.ask && extras.widget ? `<script src="${basePath}/__shoalrun/ask.js" defer></script>` : ''}`;
176
+ if (injected && file.endsWith('.html') && request.method !== 'HEAD')
177
+ body = Buffer.from(body.toString('utf8').replace('</body>', `${injected}</body>`));
178
+ sendRepresentation(body, { ...(headers[pathname] ?? { 'Content-Type': types[path.extname(file)] ?? 'application/octet-stream' }), ...(file.toLowerCase().endsWith('.svg') ? { 'Content-Security-Policy': 'sandbox' } : {}), ...(document ? { Vary: 'Accept', Link: `<${document.markdownUrl}>; rel="alternate"; type="text/markdown"` } : {}) });
179
+ }
180
+ catch (error) {
181
+ const missing = ['ENOENT', 'ENOTDIR'].includes(error.code ?? '') || error instanceof URIError || (error instanceof Error && error.message === 'Invalid path');
182
+ if (!missing) {
183
+ response.writeHead(500, { 'Content-Type': 'text/plain; charset=utf-8' });
184
+ response.end(request.method === 'HEAD' ? undefined : 'Internal server error\n');
185
+ return;
186
+ }
187
+ const { manifest, search, errorHtml, home } = recoveryState;
188
+ const basePath = manifest.basePath ?? '';
189
+ if (liveClients && manifest.buildId !== mcpBuild) {
190
+ const next = await loadMcpRuntime(root);
191
+ mcp = next;
192
+ mcpHandler = next ? createMcpHttpHandler(next) : undefined;
193
+ mcpBuild = manifest.buildId;
194
+ }
195
+ const internalPath = pathname.toLowerCase().replace(/\/+$/, '');
196
+ if (internalPath === '/mcp-runtime.json' || internalPath === '/__shoalrun/mcp-data' || internalPath.startsWith('/__shoalrun/mcp-data/')) {
197
+ response.writeHead(404);
198
+ response.end();
199
+ return;
200
+ }
201
+ if (mcp && mcpHandler && pathname === mcp.runtime.path) {
202
+ await bridgeMcp(request, response, mcpHandler);
203
+ return;
204
+ }
205
+ const markdown = pathname.endsWith('.md') || !!negotiatedDocument('/', request.headers.accept, [{ url: '/', markdownUrl: '/index.md' }]);
206
+ const document = manifest.documents.find(item => item.markdownUrl === pathname || (markdown && item.url === (pathname.replace(/\/+$/, '') || '/')));
207
+ const twin = document && await siteFile(document.url === '/' ? '/index.html' : `${document.url}/index.html`).then(file => stat(file)).then(info => info.isFile()).catch(() => false) ? document.url : undefined;
208
+ response.writeHead(404, { 'Content-Type': markdown ? 'text/markdown; charset=utf-8' : 'text/html; charset=utf-8', Vary: 'Accept', 'X-Robots-Tag': 'noindex', ...(twin ? { Link: `<${twin}>; rel="alternate"; type="text/html"` } : {}) });
209
+ const body = !markdown && errorHtml ? (twin ? addNotFoundTwin(errorHtml, twin) : errorHtml) : notFoundPage(basePath, home ?? `${basePath}/`, markdown, twin, search);
210
+ response.end(request.method === 'HEAD' ? undefined : body);
211
+ }
212
+ });
213
+ }
214
+ export async function serveSite(directory, host, port, liveClients, extras) {
215
+ if (!Number.isInteger(port) || port < 0 || port > 65535)
216
+ throw new Error('Server port must be an integer from 0 to 65535');
217
+ const server = await createSiteServer(directory, liveClients, extras);
218
+ await new Promise((resolve, reject) => {
219
+ server.once('error', reject);
220
+ server.listen(port, host, () => { server.off('error', reject); resolve(); });
221
+ });
222
+ return server;
223
+ }
@@ -0,0 +1,24 @@
1
+ import type { Palette } from './palettes.js';
2
+ export type ShareSettings = {
3
+ enabled: boolean;
4
+ template?: string;
5
+ fonts: string[];
6
+ };
7
+ export type ShareCard = {
8
+ title: string;
9
+ summary: string;
10
+ site: string;
11
+ type: string;
12
+ url: string;
13
+ };
14
+ export declare const shareWidth = 1200;
15
+ export declare const shareHeight = 630;
16
+ export declare function resolveShareImages(value: unknown, declaringFile: string): ShareSettings;
17
+ export declare const shareRoute: (route: string) => string;
18
+ export declare function wrapText(text: string, widths: Record<string, number>, size: number, maxWidth: number, maxLines: number): string[];
19
+ export declare function defaultShareSvg(card: ShareCard, preset: string, palette: Palette): Promise<string>;
20
+ export declare function fillShareTemplate(template: string, card: ShareCard, file: string): string;
21
+ export declare const bundledShareFonts: () => string[];
22
+ export declare function renderPng(svg: string, fontFiles: string[], cacheDirectory: string, width?: number): Promise<Buffer>;
23
+ export declare function faviconSvg(preset: string, palette: Palette): string;
24
+ export declare function touchIconSvg(icon: string, palette: Palette): string;
@@ -0,0 +1,187 @@
1
+ import path from 'node:path';
2
+ import { createHash } from 'node:crypto';
3
+ import { existsSync } from 'node:fs';
4
+ import { mkdir, readFile, stat, writeFile } from 'node:fs/promises';
5
+ import { createRequire } from 'node:module';
6
+ import { fileURLToPath } from 'node:url';
7
+ // Share images: a 1200×630 PNG per page for link previews, drawn from an SVG template with resvg at build time.
8
+ // resvg reads TrueType and OpenType only, so styles/fonts/share holds static TTF cuts of the bundled fonts
9
+ // plus their glyph widths, which the default template uses to wrap titles.
10
+ const shareFontDirectory = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '../styles/fonts/share');
11
+ export const shareWidth = 1200;
12
+ export const shareHeight = 630;
13
+ const presetFonts = {
14
+ shoal: { title: 'inter-700.ttf', body: 'inter-400.ttf' },
15
+ reef: { title: 'figtree-700.ttf', body: 'figtree-400.ttf' },
16
+ ledger: { title: 'jetbrains-mono-700.ttf', body: 'source-serif-4-400.ttf' },
17
+ vice: { title: 'jost-italic-800.ttf', body: 'figtree-400.ttf' }
18
+ };
19
+ const fontFormats = new Set(['.ttf', '.otf']);
20
+ // outputs.html.shareImages: omitted or true draws the default card, false turns images off, and a mapping names a template.
21
+ export function resolveShareImages(value, declaringFile) {
22
+ if (value === undefined || value === true)
23
+ return { enabled: true, fonts: [] };
24
+ if (value === false)
25
+ return { enabled: false, fonts: [] };
26
+ if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).some(key => !['template', 'fonts'].includes(key)))
27
+ throw new Error('outputs.html.shareImages must be true, false, or a mapping with template and fonts');
28
+ const settings = value;
29
+ const local = (file) => path.resolve(path.dirname(declaringFile), file);
30
+ if (settings.template !== undefined && (typeof settings.template !== 'string' || path.extname(settings.template).toLowerCase() !== '.svg'))
31
+ throw new Error('outputs.html.shareImages.template must be a local .svg file');
32
+ const fonts = settings.fonts ?? [];
33
+ if (!Array.isArray(fonts) || fonts.some(file => typeof file !== 'string' || !fontFormats.has(path.extname(file).toLowerCase())))
34
+ throw new Error('outputs.html.shareImages.fonts must list local .ttf or .otf files');
35
+ const resolved = { enabled: true, template: settings.template === undefined ? undefined : local(settings.template), fonts: fonts.map(local) };
36
+ for (const file of [...(resolved.template ? [resolved.template] : []), ...resolved.fonts])
37
+ if (!existsSync(file))
38
+ throw new Error(`outputs.html.shareImages: file not found: ${file}`);
39
+ return resolved;
40
+ }
41
+ // Each page's image lives beside its route, so /styling/themes becomes /assets/share/styling/themes.png.
42
+ export const shareRoute = (route) => `/assets/share${route === '/' ? '/index' : route}.png`;
43
+ const escape = (value) => value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
44
+ let metricsCache;
45
+ async function metrics() {
46
+ metricsCache ??= JSON.parse(await readFile(path.join(shareFontDirectory, 'metrics.json'), 'utf8'));
47
+ return metricsCache;
48
+ }
49
+ // Greedy word wrap using the font's advance widths; the last line gets an ellipsis when text is cut.
50
+ export function wrapText(text, widths, size, maxWidth, maxLines) {
51
+ const measure = (value) => [...value].reduce((total, char) => total + (widths[char] ?? .56) * size, 0);
52
+ const lines = [];
53
+ let line = '';
54
+ for (const word of text.split(/\s+/).filter(Boolean)) {
55
+ const next = line ? `${line} ${word}` : word;
56
+ if (measure(next) <= maxWidth || !line) {
57
+ line = next;
58
+ continue;
59
+ }
60
+ lines.push(line);
61
+ line = word;
62
+ }
63
+ if (line)
64
+ lines.push(line);
65
+ if (lines.length <= maxLines)
66
+ return lines;
67
+ const kept = lines.slice(0, maxLines);
68
+ let last = kept[maxLines - 1];
69
+ while (last && measure(`${last}…`) > maxWidth)
70
+ last = last.replace(/\s*\S+$/, '');
71
+ kept[maxLines - 1] = `${last}…`;
72
+ return kept;
73
+ }
74
+ // Lines split at word boundaries by character count, for project templates whose fonts the build cannot measure.
75
+ function wrapByCharacters(text, perLine, maxLines) {
76
+ const widths = new Proxy({}, { get: () => 1 });
77
+ return wrapText(text, widths, 1, perLine, maxLines);
78
+ }
79
+ function brandMark(preset, x, y, size, palette) {
80
+ const accent = palette.dark.accent;
81
+ if (preset === 'ledger')
82
+ return `<rect x="${x}" y="${y}" width="${size}" height="${size}" fill="${accent}"/>`;
83
+ if (preset === 'vice')
84
+ return `<defs><linearGradient id="sun" x1="0" y1="0" x2="0" y2="1"><stop offset="0" stop-color="#ffd166"/><stop offset=".45" stop-color="#ff8a3d"/><stop offset="1" stop-color="#ff4fa3"/></linearGradient></defs><circle cx="${x + size / 2}" cy="${y + size / 2}" r="${size / 2}" fill="url(#sun)"/>`;
85
+ if (preset === 'reef')
86
+ return `<rect x="${x}" y="${y}" width="${size}" height="${size}" rx="${size * .3}" fill="${accent}" transform="rotate(12 ${x + size / 2} ${y + size / 2})"/>`;
87
+ const s = size / 64;
88
+ return `<g transform="translate(${x} ${y}) scale(${s})" fill="${accent}"><path d="M4 40c2-7 6-11 10-11 5 0 8 5 8 12v3H4z"/><path d="M26 37c2-10 6-16 10-16 5 0 9 7 9 17v6H26z"/><path d="M47 40c2-7 5-10 9-10 5 0 8 5 8 11v3H47z"/><path d="M5 51c8-4 15-4 23 0s15 4 23 0 10-4 13-3" fill="none" stroke="${accent}" stroke-width="4" stroke-linecap="round"/><path d="M5 59c8-4 15-4 23 0s15 4 23 0 10-4 13-3" fill="none" stroke="${accent}" stroke-width="4" stroke-linecap="round"/></g>`;
89
+ }
90
+ export async function defaultShareSvg(card, preset, palette) {
91
+ const fonts = presetFonts[preset] ?? presetFonts.shoal;
92
+ const all = await metrics();
93
+ const titleFont = all[fonts.title];
94
+ const bodyFont = all[fonts.body];
95
+ const pad = 80;
96
+ const width = shareWidth - pad * 2;
97
+ const background = palette.light['strong-surface'];
98
+ const ink = palette.light['strong-text'];
99
+ const accent = palette.dark.accent;
100
+ const muted = palette.dark.muted;
101
+ let size = 68;
102
+ let title = wrapText(card.title, titleFont.widths, size, width, 3);
103
+ if (title.length > 2) {
104
+ size = 56;
105
+ title = wrapText(card.title, titleFont.widths, size, width, 3);
106
+ }
107
+ const summary = card.summary ? wrapText(card.summary, bodyFont.widths, 30, width, 2) : [];
108
+ const text = (family) => `font-family="${escape(family.family)}" font-weight="${family.weight}" font-style="${family.style}"`;
109
+ const titleTop = 200;
110
+ const titleLead = size * 1.12;
111
+ const summaryTop = titleTop + (title.length - 1) * titleLead + 64;
112
+ const decoration = {
113
+ shoal: `<rect x="0" y="0" width="12" height="${shareHeight}" fill="${accent}"/>`,
114
+ reef: `<circle cx="${shareWidth - 60}" cy="${shareHeight + 40}" r="360" fill="${accent}" opacity=".22"/>`,
115
+ ledger: `<rect x="0" y="${shareHeight - 14}" width="${shareWidth}" height="14" fill="${accent}"/>`,
116
+ vice: `<defs><linearGradient id="stripe" x1="0" x2="1"><stop offset="0" stop-color="#ff4fa3"/><stop offset=".5" stop-color="#ff8a3d"/><stop offset="1" stop-color="#3ee6dc"/></linearGradient><radialGradient id="glow" cx=".85" cy="1.2" r=".8"><stop offset="0" stop-color="#ff4fa3" stop-opacity=".45"/><stop offset="1" stop-color="#ff4fa3" stop-opacity="0"/></radialGradient></defs><rect width="${shareWidth}" height="${shareHeight}" fill="url(#glow)"/><rect x="0" y="${shareHeight - 12}" width="${shareWidth}" height="12" fill="url(#stripe)"/>`
117
+ }[preset] ?? '';
118
+ const footerY = shareHeight - pad + 10;
119
+ // The URL sits at the right of the footer; drop it rather than let it collide with a long site name.
120
+ const measure = (value, widths, px) => [...value].reduce((total, char) => total + (widths[char] ?? .56) * px, 0);
121
+ const site = wrapText(card.site, titleFont.widths, 26, width - 50, 1)[0] ?? '';
122
+ const url = card.url && 50 + measure(site, titleFont.widths, 26) + 48 + measure(card.url, bodyFont.widths, 22) <= width ? card.url : '';
123
+ return [
124
+ `<svg xmlns="http://www.w3.org/2000/svg" width="${shareWidth}" height="${shareHeight}" viewBox="0 0 ${shareWidth} ${shareHeight}">`,
125
+ `<rect width="${shareWidth}" height="${shareHeight}" fill="${background}"/>`,
126
+ decoration,
127
+ `<text x="${pad}" y="${titleTop - 78}" ${text(bodyFont)} font-size="22" letter-spacing="4" fill="${accent}">${escape(card.type.toUpperCase())}</text>`,
128
+ ...title.map((line, index) => `<text x="${pad}" y="${titleTop + index * titleLead}" ${text(titleFont)} font-size="${size}" letter-spacing="${preset === 'ledger' ? -1 : -2}" fill="${ink}">${escape(line)}</text>`),
129
+ ...summary.map((line, index) => `<text x="${pad}" y="${summaryTop + index * 42}" ${text(bodyFont)} font-size="30" fill="${muted}">${escape(line)}</text>`),
130
+ brandMark(preset, pad, footerY - 30, 34, palette),
131
+ `<text x="${pad + 50}" y="${footerY}" ${text(titleFont)} font-size="26" fill="${ink}">${escape(site)}</text>`,
132
+ ...(url ? [`<text x="${shareWidth - pad}" y="${footerY}" text-anchor="end" ${text(bodyFont)} font-size="22" fill="${muted}">${escape(url)}</text>`] : []),
133
+ '</svg>'
134
+ ].join('');
135
+ }
136
+ // Project templates use {{placeholders}}; unknown names fail so a typo cannot ship an image with raw braces.
137
+ export function fillShareTemplate(template, card, file) {
138
+ const title = wrapByCharacters(card.title, 30, 3);
139
+ const summary = wrapByCharacters(card.summary, 60, 2);
140
+ const values = {
141
+ title: card.title, summary: card.summary, site: card.site, type: card.type, url: card.url,
142
+ 'title.1': title[0] ?? '', 'title.2': title[1] ?? '', 'title.3': title[2] ?? '',
143
+ 'summary.1': summary[0] ?? '', 'summary.2': summary[1] ?? ''
144
+ };
145
+ return template.replace(/\{\{\s*([\w.]+)\s*\}\}/g, (_, name) => {
146
+ if (!Object.hasOwn(values, name))
147
+ throw new Error(`${file}: unknown share image placeholder {{${name}}}; use ${Object.keys(values).join(', ')}`);
148
+ return escape(values[name]);
149
+ });
150
+ }
151
+ export const bundledShareFonts = () => Object.values(presetFonts).flatMap(font => [font.title, font.body]).filter((file, index, all) => all.indexOf(file) === index).map(file => path.join(shareFontDirectory, file));
152
+ // Rendered PNGs are cached by content, so unchanged pages skip resvg on later builds.
153
+ // The key covers the SVG, the font bytes, the output width, and the resvg version, so any change redraws.
154
+ // Digests are memoized per file version, so a font edited during `shoalrun dev` is hashed again.
155
+ const fontDigests = new Map();
156
+ const fontDigest = async (file) => {
157
+ const { mtimeMs, size } = await stat(file);
158
+ const version = `${file}|${mtimeMs}|${size}`;
159
+ if (!fontDigests.has(version))
160
+ fontDigests.set(version, readFile(file).then(bytes => createHash('sha256').update(bytes).digest('hex')));
161
+ return fontDigests.get(version);
162
+ };
163
+ const resvgVersion = String(createRequire(import.meta.url)('@resvg/resvg-js/package.json').version);
164
+ export async function renderPng(svg, fontFiles, cacheDirectory, width = shareWidth) {
165
+ const { Resvg } = await import('@resvg/resvg-js');
166
+ const key = createHash('sha256').update(JSON.stringify([svg, await Promise.all(fontFiles.map(fontDigest)), width, resvgVersion])).digest('hex').slice(0, 24);
167
+ const cached = path.join(cacheDirectory, `${key}.png`);
168
+ if (existsSync(cached))
169
+ return readFile(cached);
170
+ const png = new Resvg(svg, { fitTo: { mode: 'width', value: width }, font: { fontFiles, loadSystemFonts: false, defaultFontFamily: 'Inter' } }).render().asPng();
171
+ await mkdir(cacheDirectory, { recursive: true });
172
+ await writeFile(cached, png);
173
+ return png;
174
+ }
175
+ // The favicon repeats the preset's brand mark in the palette accent; a 180px touch icon puts it on the inked surface.
176
+ export function faviconSvg(preset, palette) {
177
+ const light = { ...palette, dark: { ...palette.dark, accent: palette.light.accent } };
178
+ return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="64" height="64">${brandMark(preset, preset === 'shoal' ? 0 : 6, preset === 'shoal' ? 0 : 6, preset === 'shoal' ? 64 : 52, light)}</svg>`;
179
+ }
180
+ export function touchIconSvg(icon, palette) {
181
+ // Nest the icon's own <svg> so its viewBox still applies; only its position and size change.
182
+ const body = icon.replace(/^(?:\s|<\?xml[\s\S]*?\?>|<!--[\s\S]*?-->|<!DOCTYPE[^>]*>)+/i, '');
183
+ if (!/^<svg\b/.test(body))
184
+ throw new Error('site.favicon must be an SVG document with an <svg> root element');
185
+ const nested = body.replace(/^<svg\b([^>]*)>/, (_, attributes) => `<svg${attributes.replace(/\s(?:x|y|width|height)=(?:"[^"]*"|'[^']*')/g, '')} x="40" y="40" width="100" height="100">`);
186
+ return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 180 180" width="180" height="180"><rect width="180" height="180" fill="${palette.light['strong-surface']}"/>${nested}</svg>`;
187
+ }
@@ -0,0 +1,2 @@
1
+ export declare function normalizeBasePath(value: unknown): string;
2
+ export declare function sitePath(basePath: string, route: string): string;
@@ -0,0 +1,15 @@
1
+ // The mount point for every public URL in a built site. Internal build manifests
2
+ // remain at the output root so local tools can find them without a config file.
3
+ export function normalizeBasePath(value) {
4
+ if (value === undefined || value === '')
5
+ return '';
6
+ if (typeof value !== 'string' || !/^\/(?:[A-Za-z0-9._~-]+)(?:\/[A-Za-z0-9._~-]+)*\/?$/.test(value) || value.split('/').some(part => part === '.' || part === '..')) {
7
+ throw new Error('site.basePath must be a path such as /docs without queries, escapes, or dot segments');
8
+ }
9
+ return value.replace(/\/$/, '');
10
+ }
11
+ export function sitePath(basePath, route) {
12
+ if (!route.startsWith('/') || route.startsWith('//'))
13
+ throw new Error(`Invalid public route ${route}`);
14
+ return `${basePath}${route}`;
15
+ }
@@ -0,0 +1,8 @@
1
+ export type SitemapPage = {
2
+ route: string;
3
+ updated?: string;
4
+ };
5
+ export declare function sitemapFiles(origin: string, pages: SitemapPage[], limits?: {
6
+ urls?: number;
7
+ bytes?: number;
8
+ }, basePath?: string): Map<string, string>;
@@ -0,0 +1,58 @@
1
+ // Sitemaps use the same published routes as HTML, with no build-time dates pretending to be content updates.
2
+ const namespace = 'http://www.sitemaps.org/schemas/sitemap/0.9';
3
+ const maxUrls = 50_000;
4
+ const maxBytes = 50 * 1024 * 1024;
5
+ const escapeXml = (value) => value.replace(/[&<>"']/g, character => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;', "'": '&apos;' })[character]);
6
+ const header = '<?xml version="1.0" encoding="UTF-8"?>\n';
7
+ const entry = (url, updated) => ` <url><loc>${escapeXml(url)}</loc>${updated ? `<lastmod>${escapeXml(updated)}</lastmod>` : ''}</url>`;
8
+ const urlset = (entries) => `${header}<urlset xmlns="${namespace}">\n${entries.map(page => entry(page.url, page.updated)).join('\n')}\n</urlset>\n`;
9
+ export function sitemapFiles(origin, pages, limits = {}, basePath = '') {
10
+ const base = new URL(origin);
11
+ if (base.protocol !== 'https:' || base.username || base.password || base.pathname !== '/' || base.search || base.hash)
12
+ throw new Error('site.origin must be an HTTPS origin without a path, query, or fragment');
13
+ const urls = pages.map(({ route, updated }) => {
14
+ if (!route.startsWith('/') || route.startsWith('//') || /[?#\\]/.test(route))
15
+ throw new Error(`Invalid sitemap route ${route}`);
16
+ return { url: new URL(route, base).href, updated };
17
+ }).sort((a, b) => a.url.localeCompare(b.url));
18
+ if (new Set(urls.map(page => page.url)).size !== urls.length)
19
+ throw new Error('The sitemap has duplicate canonical URLs');
20
+ const files = new Map();
21
+ const chunks = [];
22
+ let current = [];
23
+ let size = Buffer.byteLength(urlset([]));
24
+ for (const page of urls) {
25
+ const added = Buffer.byteLength(entry(page.url, page.updated)) + (current.length ? 1 : 0);
26
+ if (current.length + 1 > (limits.urls ?? maxUrls) || size + added > (limits.bytes ?? maxBytes)) {
27
+ if (!current.length)
28
+ throw new Error(`Sitemap URL is too large: ${page.url}`);
29
+ chunks.push(current);
30
+ current = [page];
31
+ size = Buffer.byteLength(urlset(current));
32
+ }
33
+ else {
34
+ current.push(page);
35
+ size += added;
36
+ }
37
+ }
38
+ if (current.length)
39
+ chunks.push(current);
40
+ if (!chunks.length)
41
+ return files;
42
+ if (chunks.length === 1) {
43
+ files.set(`${basePath}/sitemap.xml`, urlset(chunks[0]));
44
+ return files;
45
+ }
46
+ if (chunks.length > maxUrls)
47
+ throw new Error('The sitemap needs more than 50,000 child files; split this site by origin');
48
+ const children = chunks.map((chunk, index) => {
49
+ const route = `${basePath}/sitemap-${index + 1}.xml`;
50
+ files.set(route, urlset(chunk));
51
+ return `${base.origin}${route}`;
52
+ });
53
+ const index = `${header}<sitemapindex xmlns="${namespace}">\n${children.map(url => ` <sitemap><loc>${escapeXml(url)}</loc></sitemap>`).join('\n')}\n</sitemapindex>\n`;
54
+ if (Buffer.byteLength(index) > maxBytes)
55
+ throw new Error('The sitemap index exceeds 50 MB; split this site by origin');
56
+ files.set(`${basePath}/sitemap.xml`, index);
57
+ return files;
58
+ }
@@ -0,0 +1,19 @@
1
+ export type SnippetVariable = {
2
+ type: 'string' | 'number' | 'boolean';
3
+ required?: boolean;
4
+ default?: string | number | boolean;
5
+ enum?: Array<string | number | boolean>;
6
+ };
7
+ export type SnippetDefinition = {
8
+ file: string;
9
+ tree: any;
10
+ variables: Record<string, SnippetVariable>;
11
+ };
12
+ export type SnippetUse = {
13
+ id: string;
14
+ file: string;
15
+ documentId: string;
16
+ };
17
+ export declare function validateSnippetConfig(id: string, definition: any): Record<string, SnippetVariable>;
18
+ export declare function snippetAttribute(attribute: any, label: string): unknown;
19
+ export declare function resolveSnippetValues(id: string, definition: SnippetDefinition, projectValues: unknown, pageValues: unknown, invocation: Record<string, unknown>): Record<string, string | number | boolean>;
@@ -0,0 +1,84 @@
1
+ const object = (value) => !!value && typeof value === 'object' && !Array.isArray(value);
2
+ const safeName = (name) => /^[A-Za-z_][A-Za-z0-9_-]*$/.test(name) && !['__proto__', 'prototype', 'constructor'].includes(name);
3
+ const safeId = (id) => /^[A-Za-z_][A-Za-z0-9_.-]*$/.test(id) && id.split('.').every(safeName);
4
+ export function validateSnippetConfig(id, definition) {
5
+ if (!safeId(id))
6
+ throw new Error(`Invalid snippet ID ${id}`);
7
+ if (!object(definition))
8
+ throw new Error(`Snippet ${id} must be a mapping`);
9
+ for (const key of Object.keys(definition))
10
+ if (!['file', 'variables'].includes(key))
11
+ throw new Error(`Unknown snippet setting ${id}.${key}`);
12
+ if (typeof definition.file !== 'string' || !/\.mdx?$/.test(definition.file))
13
+ throw new Error(`Snippet ${id} needs a .md or .mdx file`);
14
+ const variables = definition.variables ?? {};
15
+ if (!object(variables))
16
+ throw new Error(`Snippet ${id}.variables must be a mapping`);
17
+ for (const [name, variable] of Object.entries(variables)) {
18
+ if (!safeName(name) || !object(variable))
19
+ throw new Error(`Invalid snippet variable ${id}.${name}`);
20
+ for (const key of Object.keys(variable))
21
+ if (!['type', 'required', 'default', 'enum'].includes(key))
22
+ throw new Error(`Unknown snippet variable setting ${id}.${name}.${key}`);
23
+ if (!['string', 'number', 'boolean'].includes(variable.type))
24
+ throw new Error(`Snippet ${id}.${name} needs a scalar type`);
25
+ if (variable.required !== undefined && typeof variable.required !== 'boolean')
26
+ throw new Error(`Snippet ${id}.${name}.required must be boolean`);
27
+ if (variable.default !== undefined && typeof variable.default !== variable.type)
28
+ throw new Error(`Snippet ${id}.${name}.default must be ${variable.type}`);
29
+ if (variable.enum !== undefined && (!Array.isArray(variable.enum) || !variable.enum.length || variable.enum.some((item) => typeof item !== variable.type)))
30
+ throw new Error(`Snippet ${id}.${name}.enum must contain ${variable.type} values`);
31
+ if (variable.default !== undefined && variable.enum && !variable.enum.includes(variable.default))
32
+ throw new Error(`Snippet ${id}.${name}.default is not in its enum`);
33
+ }
34
+ return variables;
35
+ }
36
+ function literal(node) {
37
+ if (node?.type === 'Literal' && ['string', 'number', 'boolean'].includes(typeof node.value))
38
+ return node.value;
39
+ if (node?.type === 'ObjectExpression') {
40
+ const result = {};
41
+ for (const property of node.properties ?? []) {
42
+ if (property.type !== 'Property' || property.computed || property.method || property.shorthand || property.kind !== 'init')
43
+ throw new Error('Snippet values must be literal properties');
44
+ const name = property.key.type === 'Identifier' ? property.key.name : property.key.type === 'Literal' ? property.key.value : null;
45
+ if (typeof name !== 'string' || !safeName(name) || Object.prototype.hasOwnProperty.call(result, name))
46
+ throw new Error(`Invalid snippet value name ${name}`);
47
+ result[name] = literal(property.value);
48
+ }
49
+ return result;
50
+ }
51
+ throw new Error('Snippet values must be literal strings, numbers, or booleans');
52
+ }
53
+ export function snippetAttribute(attribute, label) {
54
+ if (typeof attribute.value === 'string')
55
+ return attribute.value;
56
+ const program = attribute.value?.data?.estree;
57
+ if (program?.body?.length === 1 && program.body[0].type === 'ExpressionStatement')
58
+ return literal(program.body[0].expression);
59
+ throw new Error(`${label}: snippet attributes must be literal values`);
60
+ }
61
+ export function resolveSnippetValues(id, definition, projectValues, pageValues, invocation) {
62
+ if (projectValues !== undefined && !object(projectValues))
63
+ throw new Error('Project variables must be a mapping');
64
+ if (pageValues !== undefined && !object(pageValues))
65
+ throw new Error('Page variables must be a mapping');
66
+ const values = {};
67
+ for (const [name, variable] of Object.entries(definition.variables)) {
68
+ const value = invocation[name] ?? pageValues?.[name] ?? projectValues?.[name] ?? variable.default;
69
+ if (value === undefined) {
70
+ if (variable.required)
71
+ throw new Error(`Snippet ${id} requires variable ${name}`);
72
+ continue;
73
+ }
74
+ if (typeof value !== variable.type)
75
+ throw new Error(`Snippet ${id}.${name} must be ${variable.type}`);
76
+ if (variable.enum && !variable.enum.includes(value))
77
+ throw new Error(`Snippet ${id}.${name} is not in its enum`);
78
+ values[name] = value;
79
+ }
80
+ for (const name of Object.keys(invocation))
81
+ if (!(name in definition.variables))
82
+ throw new Error(`Unknown snippet variable ${id}.${name}`);
83
+ return values;
84
+ }