@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.
- package/AUTHORING.md +269 -0
- package/CHANGELOG.md +82 -0
- package/LICENSE +202 -0
- package/README.md +189 -2
- package/agent-docs/.well-known/shoalrun/navigation/changelog-tab-50f26fe22670.txt +33 -0
- package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +9 -0
- package/agent-docs/SNAPSHOT.json +9 -0
- package/agent-docs/about.md +49 -0
- package/agent-docs/api-docs/focused-contracts.md +68 -0
- package/agent-docs/api-docs/generate.md +189 -0
- package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
- package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
- package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
- package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
- package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
- package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
- package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
- package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
- package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
- package/agent-docs/api-docs/support.md +97 -0
- package/agent-docs/author/add-page.md +124 -0
- package/agent-docs/author/agent-overview.md +59 -0
- package/agent-docs/author/agent-workflow.md +65 -0
- package/agent-docs/author/agents.md +53 -0
- package/agent-docs/author/analytics.md +286 -0
- package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
- package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
- package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
- package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
- package/agent-docs/author/analytics.sections/event-format.md +59 -0
- package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
- package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
- package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
- package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
- package/agent-docs/author/analytics.sections/related-reading.md +42 -0
- package/agent-docs/author/authoring-agent.md +102 -0
- package/agent-docs/author/coding-agent.md +90 -0
- package/agent-docs/author/components/action-link.md +41 -0
- package/agent-docs/author/components/api-embeds.md +263 -0
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +117 -0
- package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
- package/agent-docs/author/components/badge.md +76 -0
- package/agent-docs/author/components/breadcrumbs.md +57 -0
- package/agent-docs/author/components/callout.md +131 -0
- package/agent-docs/author/components/cards.md +168 -0
- package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
- package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
- package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
- package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
- package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
- package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
- package/agent-docs/author/components/code-blocks.md +117 -0
- package/agent-docs/author/components/collapsible.md +99 -0
- package/agent-docs/author/components/cookbook-chooser.md +86 -0
- package/agent-docs/author/components/custom/react.md +190 -0
- package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
- package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
- package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
- package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
- package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
- package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
- package/agent-docs/author/components/custom.md +183 -0
- package/agent-docs/author/components/definition-list.md +54 -0
- package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
- package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
- package/agent-docs/author/components/diagrams.md +155 -0
- package/agent-docs/author/components/doc-link.md +58 -0
- package/agent-docs/author/components/fields.md +121 -0
- package/agent-docs/author/components/file-tree.md +84 -0
- package/agent-docs/author/components/images.md +103 -0
- package/agent-docs/author/components/info-hint.md +61 -0
- package/agent-docs/author/components/kbd.md +45 -0
- package/agent-docs/author/components/math.md +39 -0
- package/agent-docs/author/components/only.md +65 -0
- package/agent-docs/author/components/progress.md +53 -0
- package/agent-docs/author/components/related-reading.md +48 -0
- package/agent-docs/author/components/steps.md +121 -0
- package/agent-docs/author/components/tables.md +64 -0
- package/agent-docs/author/components/tabs.md +129 -0
- package/agent-docs/author/components/timeline.md +74 -0
- package/agent-docs/author/components/tooltips.md +58 -0
- package/agent-docs/author/components/walkthroughs.md +390 -0
- package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
- package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
- package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
- package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
- package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
- package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +53 -0
- package/agent-docs/author/components.md +78 -0
- package/agent-docs/author/content.md +74 -0
- package/agent-docs/author/cookbooks.md +119 -0
- package/agent-docs/author/css.md +238 -0
- package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
- package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
- package/agent-docs/author/css.sections/page-attributes.md +69 -0
- package/agent-docs/author/css.sections/page-transitions.md +60 -0
- package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
- package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
- package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
- package/agent-docs/author/custom-metadata.md +177 -0
- package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
- package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
- package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
- package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
- package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
- package/agent-docs/author/design-templates.md +49 -0
- package/agent-docs/author/design-writing-guides.md +73 -0
- package/agent-docs/author/frontmatter-reference.md +146 -0
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
- package/agent-docs/author/frontmatter.md +255 -0
- package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
- package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
- package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
- package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
- package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
- package/agent-docs/author/markdown-metadata.md +207 -0
- package/agent-docs/author/navigation.md +269 -0
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
- package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
- package/agent-docs/author/navigation.sections/related-reading.md +44 -0
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
- package/agent-docs/author/reader-views.md +200 -0
- package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
- package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
- package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
- package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
- package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
- package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
- package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
- package/agent-docs/author/recipe-drafts.md +181 -0
- package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
- package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
- package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
- package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
- package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
- package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
- package/agent-docs/author/recipes.md +127 -0
- package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
- package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
- package/agent-docs/author/recipes.sections/related-reading.md +36 -0
- package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
- package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
- package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
- package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
- package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
- package/agent-docs/author/related-reading.md +143 -0
- package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
- package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
- package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
- package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
- package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
- package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
- package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
- package/agent-docs/author/release-notes.md +153 -0
- package/agent-docs/author/search.md +299 -0
- package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
- package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
- package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
- package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/search.sections/lexical-search.md +78 -0
- package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
- package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
- package/agent-docs/author/search.sections/related-reading.md +45 -0
- package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
- package/agent-docs/author/search.sections/turn-search-off.md +46 -0
- package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
- package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
- package/agent-docs/author/snippets.md +118 -0
- package/agent-docs/author/taxonomy.md +121 -0
- package/agent-docs/author/templates.md +231 -0
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
- package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
- package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
- package/agent-docs/author/templates.sections/related-reading.md +47 -0
- package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
- package/agent-docs/author/workspace/commands.md +92 -0
- package/agent-docs/author/workspace.md +104 -0
- package/agent-docs/author/writing-style.md +137 -0
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +42 -0
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +41 -0
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
- package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
- package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
- package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
- package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
- package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
- package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
- package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
- package/agent-docs/changelog/2026-10-25.md +45 -0
- package/agent-docs/changelog/2026-10-26.md +66 -0
- package/agent-docs/changelog/2026-10-27.md +85 -0
- package/agent-docs/changelog/authoring-preview.md +40 -0
- package/agent-docs/changelog/authoring-search.md +39 -0
- package/agent-docs/changelog/authoring-tools.md +34 -0
- package/agent-docs/changelog/working-tree-skill.md +38 -0
- package/agent-docs/changelog.md +115 -0
- package/agent-docs/chat/checks.md +175 -0
- package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
- package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
- package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
- package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
- package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
- package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
- package/agent-docs/chat/checks.sections/related-reading.md +42 -0
- package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
- package/agent-docs/chat/host.md +222 -0
- package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
- package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
- package/agent-docs/chat/host.sections/related-reading.md +43 -0
- package/agent-docs/chat/passage-index.md +228 -0
- package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
- package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
- package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
- package/agent-docs/chat/passage-index.sections/limits.md +45 -0
- package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
- package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
- package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
- package/agent-docs/chat/prepared-answers.md +116 -0
- package/agent-docs/chat/settings.md +213 -0
- package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
- package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
- package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
- package/agent-docs/chat/settings.sections/related-reading.md +32 -0
- package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
- package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
- package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
- package/agent-docs/chat/setup.md +97 -0
- package/agent-docs/chat.md +102 -0
- package/agent-docs/cli.md +445 -0
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
- package/agent-docs/cli.sections/author-pages.md +94 -0
- package/agent-docs/cli.sections/build-and-serve.md +144 -0
- package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
- package/agent-docs/cli.sections/related-reading.md +33 -0
- package/agent-docs/cli.sections/search-and-chat.md +132 -0
- package/agent-docs/cli.sections/start-a-project.md +37 -0
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
- package/agent-docs/concepts.md +133 -0
- package/agent-docs/config/apis.md +136 -0
- package/agent-docs/config/content.md +264 -0
- package/agent-docs/config/content.sections/authoring.md +58 -0
- package/agent-docs/config/content.sections/badges.md +34 -0
- package/agent-docs/config/content.sections/callouts.md +34 -0
- package/agent-docs/config/content.sections/cookbooks.md +38 -0
- package/agent-docs/config/content.sections/frontmatter.md +75 -0
- package/agent-docs/config/content.sections/readerfilters.md +44 -0
- package/agent-docs/config/content.sections/related-reading.md +34 -0
- package/agent-docs/config/content.sections/relationships.md +76 -0
- package/agent-docs/config/content.sections/snippets.md +61 -0
- package/agent-docs/config/content.sections/templates.md +57 -0
- package/agent-docs/config/content.sections/variables.md +55 -0
- package/agent-docs/config/examples.md +354 -0
- package/agent-docs/config/examples.sections/feature-showcase.md +55 -0
- package/agent-docs/config/examples.sections/minimal-site.md +80 -0
- package/agent-docs/config/examples.sections/multilingual-help-center.md +110 -0
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +153 -0
- package/agent-docs/config/examples.sections/related-reading.md +50 -0
- package/agent-docs/config/examples.sections/shared-company-preset.md +118 -0
- package/agent-docs/config/integrations.md +76 -0
- package/agent-docs/config/outputs.md +160 -0
- package/agent-docs/config/outputs.sections/exports.md +57 -0
- package/agent-docs/config/outputs.sections/metadata.md +42 -0
- package/agent-docs/config/outputs.sections/related-reading.md +34 -0
- package/agent-docs/config/publishing.md +219 -0
- package/agent-docs/config/publishing.sections/navigation.md +92 -0
- package/agent-docs/config/publishing.sections/redirects.md +79 -0
- package/agent-docs/config/publishing.sections/related-reading.md +33 -0
- package/agent-docs/config/site.md +193 -0
- package/agent-docs/config/site.sections/related-reading.md +33 -0
- package/agent-docs/config/site.sections/theme.md +74 -0
- package/agent-docs/config.md +195 -0
- package/agent-docs/configuration.md +384 -0
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
- package/agent-docs/configuration.sections/related-reading.md +42 -0
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
- package/agent-docs/configuration.sections/start-with-one-working-file.md +81 -0
- package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
- package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
- package/agent-docs/connect/mcp.md +85 -0
- package/agent-docs/contribute/agent-skills.md +72 -0
- package/agent-docs/cookbooks/authoring.md +68 -0
- package/agent-docs/cookbooks/site-workflows.md +59 -0
- package/agent-docs/cookbooks/welcome-email.md +55 -0
- package/agent-docs/documents.json +20058 -0
- package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
- package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
- package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
- package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
- package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
- package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
- package/agent-docs/example-api/cedar.md +39 -0
- package/agent-docs/example-api/create-note.md +344 -0
- package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
- package/agent-docs/example-api/write-note.md +55 -0
- package/agent-docs/explore.md +54 -0
- package/agent-docs/glossary.md +827 -0
- package/agent-docs/index.md +249 -0
- package/agent-docs/ingredients/audit-site.md +27 -0
- package/agent-docs/ingredients/build-site.md +29 -0
- package/agent-docs/ingredients/compile-framework.md +28 -0
- package/agent-docs/ingredients/complete-page.md +30 -0
- package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
- package/agent-docs/ingredients/inspect-build.md +41 -0
- package/agent-docs/ingredients/preview-site.md +31 -0
- package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
- package/agent-docs/ingredients/scaffold-page.md +28 -0
- package/agent-docs/non-goals.md +58 -0
- package/agent-docs/provenance.json +10 -0
- package/agent-docs/publish/agent-discovery.md +79 -0
- package/agent-docs/publish/agent-friendliness.md +201 -0
- package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
- package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
- package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
- package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
- package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
- package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
- package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
- package/agent-docs/publish/api-references.md +217 -0
- package/agent-docs/publish/api-references.sections/add-useful-examples.md +36 -0
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
- package/agent-docs/publish/api-references.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +36 -0
- package/agent-docs/publish/api-references.sections/generate-many-pages-selectively.md +36 -0
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
- package/agent-docs/publish/api-references.sections/link-guides-to-api-references.md +36 -0
- package/agent-docs/publish/api-references.sections/map-extension-values-to-shoalrun-status.md +36 -0
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
- package/agent-docs/publish/api-references.sections/publish-several-versions.md +36 -0
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
- package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
- package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
- package/agent-docs/publish/api-references.sections/use-a-template-for-editorial-context.md +36 -0
- package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
- package/agent-docs/publish/audit.md +160 -0
- package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
- package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
- package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
- package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
- package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
- package/agent-docs/publish/audit.sections/related-reading.md +47 -0
- package/agent-docs/publish/content-export.md +208 -0
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
- package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
- package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
- package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
- package/agent-docs/publish/content-negotiation.md +121 -0
- package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
- package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
- package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
- package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
- package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
- package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
- package/agent-docs/publish/deployment-check.md +72 -0
- package/agent-docs/publish/evals.md +175 -0
- package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
- package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
- package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
- package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
- package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
- package/agent-docs/publish/evals.sections/related-reading.md +36 -0
- package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
- package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
- package/agent-docs/publish/host-adapters.md +60 -0
- package/agent-docs/publish/manni.md +227 -0
- package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
- package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
- package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
- package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
- package/agent-docs/publish/mcp-analytics.md +356 -0
- package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
- package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
- package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
- package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
- package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
- package/agent-docs/publish/mcp.md +190 -0
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
- package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
- package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
- package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
- package/agent-docs/publish/openapi-extension-mappings.md +84 -0
- package/agent-docs/publish/output.md +220 -0
- package/agent-docs/publish/output.sections/api-contracts.md +48 -0
- package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
- package/agent-docs/publish/output.sections/current-limits.md +40 -0
- package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
- package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
- package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
- package/agent-docs/publish/output.sections/page-formats.md +46 -0
- package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
- package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
- package/agent-docs/publish/output.sections/related-reading.md +34 -0
- package/agent-docs/publish/output.sections/response-identity.md +38 -0
- package/agent-docs/publish/output.sections/site-files.md +64 -0
- package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
- package/agent-docs/publish/output.sections/where-files-go.md +49 -0
- package/agent-docs/publish/publications.md +153 -0
- package/agent-docs/publish/revisions.md +104 -0
- package/agent-docs/publish/seo.md +119 -0
- package/agent-docs/publish/single-source-sites.md +168 -0
- package/agent-docs/publish/troubleshooting.md +112 -0
- package/agent-docs/publish/vercel.md +130 -0
- package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
- package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
- package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
- package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
- package/agent-docs/publish.md +95 -0
- package/agent-docs/recipes/add-page.md +194 -0
- package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
- package/agent-docs/recipes/add-page.sections/before-you-start.md +33 -0
- package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
- package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
- package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
- package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
- package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +42 -0
- package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
- package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
- package/agent-docs/recipes/audit-docs.md +122 -0
- package/agent-docs/recipes/build-docs.md +105 -0
- package/agent-docs/recipes/preview-hybrid-search.md +84 -0
- package/agent-docs/recipes/preview-page.md +124 -0
- package/agent-docs/recipes/queue-email.md +49 -0
- package/agent-docs/recipes/refresh-agent-docs.md +109 -0
- package/agent-docs/recipes/send-welcome-email.md +92 -0
- package/agent-docs/reference/agent-skills.md +73 -0
- package/agent-docs/search-and-chat.md +87 -0
- package/agent-docs/search-index.json +1 -0
- package/agent-docs/start.md +197 -0
- package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
- package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
- package/agent-docs/start.sections/build-this-site.md +35 -0
- package/agent-docs/start.sections/check-writing-style.md +35 -0
- package/agent-docs/start.sections/create-a-page.md +105 -0
- package/agent-docs/start.sections/make-it-yours.md +37 -0
- package/agent-docs/start.sections/prerequisites.md +37 -0
- package/agent-docs/start.sections/related-reading.md +45 -0
- package/agent-docs/start.sections/start-your-own-project.md +53 -0
- package/agent-docs/status.md +75 -0
- package/agent-docs/styling/color-modes.md +85 -0
- package/agent-docs/styling/footer.md +67 -0
- package/agent-docs/styling/header.md +65 -0
- package/agent-docs/styling/layouts.md +193 -0
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
- package/agent-docs/styling/layouts.sections/hero.md +83 -0
- package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
- package/agent-docs/styling/palettes.md +140 -0
- package/agent-docs/styling/share-images.md +105 -0
- package/agent-docs/styling/themes.md +125 -0
- package/agent-docs/styling/try.md +106 -0
- package/agent-docs/what-is-shoalrun.md +56 -0
- package/assets/analytics.js +72 -0
- package/assets/ask-widget.js +320 -0
- package/assets/code-samples.js +28 -0
- package/assets/components.js +32 -0
- package/assets/cookbook-chooser.js +170 -0
- package/assets/copy-markdown.js +24 -0
- package/assets/example-panel.js +77 -0
- package/assets/file-tree.js +49 -0
- package/assets/image-viewer.js +41 -0
- package/assets/mode.js +26 -0
- package/assets/navigation.js +233 -0
- package/assets/reader-filters.js +305 -0
- package/assets/reader.js +111 -0
- package/assets/search-highlight.js +32 -0
- package/assets/search-lexical.js +66 -0
- package/assets/search.js +150 -0
- package/assets/table-filter.js +63 -0
- package/assets/tabs.js +80 -0
- package/assets/theme-preview.css +17 -0
- package/assets/theme-preview.js +135 -0
- package/assets/theme-switcher.js +113 -0
- package/assets/tooltips.js +81 -0
- package/assets/walkthrough.js +233 -0
- package/dist/agent-discovery.d.ts +11 -0
- package/dist/agent-discovery.js +37 -0
- package/dist/analytics.d.ts +2 -0
- package/dist/analytics.js +13 -0
- package/dist/answer-cache.d.ts +24 -0
- package/dist/answer-cache.js +55 -0
- package/dist/answer-cards.d.ts +71 -0
- package/dist/answer-cards.js +148 -0
- package/dist/api-embeds.d.ts +22 -0
- package/dist/api-embeds.js +84 -0
- package/dist/api-identity.d.ts +6 -0
- package/dist/api-identity.js +7 -0
- package/dist/api-materialize.d.ts +12 -0
- package/dist/api-materialize.js +120 -0
- package/dist/api-publication-plan.d.ts +86 -0
- package/dist/api-publication-plan.js +187 -0
- package/dist/api-publication-review.d.ts +23 -0
- package/dist/api-publication-review.js +58 -0
- package/dist/api-selection.d.ts +21 -0
- package/dist/api-selection.js +84 -0
- package/dist/api.d.ts +74 -0
- package/dist/api.js +782 -0
- package/dist/artifact-bundle.d.ts +96 -0
- package/dist/artifact-bundle.js +306 -0
- package/dist/ask-function.d.ts +19 -0
- package/dist/ask-function.js +139 -0
- package/dist/ask-handler.d.ts +38 -0
- package/dist/ask-handler.js +157 -0
- package/dist/ask-log-kv.d.ts +14 -0
- package/dist/ask-log-kv.js +69 -0
- package/dist/ask-log.d.ts +106 -0
- package/dist/ask-log.js +159 -0
- package/dist/ask-setup.d.ts +43 -0
- package/dist/ask-setup.js +99 -0
- package/dist/ask.d.ts +152 -0
- package/dist/ask.js +532 -0
- package/dist/audit.d.ts +29 -0
- package/dist/audit.js +171 -0
- package/dist/authored-change.d.ts +22 -0
- package/dist/authored-change.js +47 -0
- package/dist/authoring-api.d.ts +18 -0
- package/dist/authoring-api.js +15 -0
- package/dist/authoring-findings.d.ts +31 -0
- package/dist/authoring-findings.js +104 -0
- package/dist/authoring-guidance.d.ts +15 -0
- package/dist/authoring-guidance.js +57 -0
- package/dist/authoring-preview.d.ts +24 -0
- package/dist/authoring-preview.js +160 -0
- package/dist/authoring-project-command.d.ts +7 -0
- package/dist/authoring-project-command.js +52 -0
- package/dist/authoring-project.d.ts +104 -0
- package/dist/authoring-project.js +287 -0
- package/dist/authoring-review-command.d.ts +1 -0
- package/dist/authoring-review-command.js +68 -0
- package/dist/authoring-review.d.ts +72 -0
- package/dist/authoring-review.js +71 -0
- package/dist/authoring-snapshot.d.ts +66 -0
- package/dist/authoring-snapshot.js +293 -0
- package/dist/authoring-validation-command.d.ts +1 -0
- package/dist/authoring-validation-command.js +54 -0
- package/dist/authoring-validation.d.ts +101 -0
- package/dist/authoring-validation.js +348 -0
- package/dist/badges.d.ts +16 -0
- package/dist/badges.js +57 -0
- package/dist/budget-store.d.ts +21 -0
- package/dist/budget-store.js +90 -0
- package/dist/budget.d.ts +45 -0
- package/dist/budget.js +128 -0
- package/dist/build-info.d.ts +10 -0
- package/dist/build-info.js +15 -0
- package/dist/callouts.d.ts +18 -0
- package/dist/callouts.js +63 -0
- package/dist/cards.d.ts +35 -0
- package/dist/cards.js +237 -0
- package/dist/chat-config.d.ts +117 -0
- package/dist/chat-config.js +400 -0
- package/dist/chat-pause.d.ts +1 -0
- package/dist/chat-pause.js +3 -0
- package/dist/chat.d.ts +46 -0
- package/dist/chat.js +78 -0
- package/dist/cli-discovery.d.ts +4 -0
- package/dist/cli-discovery.js +86 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +750 -0
- package/dist/code-samples.d.ts +50 -0
- package/dist/code-samples.js +181 -0
- package/dist/compact-discovery.d.ts +15 -0
- package/dist/compact-discovery.js +78 -0
- package/dist/compiler-config.d.ts +67 -0
- package/dist/compiler-config.js +66 -0
- package/dist/compiler.d.ts +208 -0
- package/dist/compiler.js +524 -0
- package/dist/component-bundle.d.ts +4 -0
- package/dist/component-bundle.js +32 -0
- package/dist/component-content.d.ts +78 -0
- package/dist/component-content.js +47 -0
- package/dist/component-manifest.d.ts +15 -0
- package/dist/component-manifest.js +84 -0
- package/dist/component-names.d.ts +1 -0
- package/dist/component-names.js +1 -0
- package/dist/component-plugins.d.ts +28 -0
- package/dist/component-plugins.js +141 -0
- package/dist/component-transform.d.ts +10 -0
- package/dist/component-transform.js +697 -0
- package/dist/components.d.ts +2 -0
- package/dist/components.js +1 -0
- package/dist/config.d.ts +29 -0
- package/dist/config.js +149 -0
- package/dist/content-export-assets.d.ts +23 -0
- package/dist/content-export-assets.js +103 -0
- package/dist/content-export-command.d.ts +20 -0
- package/dist/content-export-command.js +57 -0
- package/dist/content-export-config.d.ts +16 -0
- package/dist/content-export-config.js +50 -0
- package/dist/content-export-render.d.ts +12 -0
- package/dist/content-export-render.js +132 -0
- package/dist/content-export.d.ts +30 -0
- package/dist/content-export.js +307 -0
- package/dist/content-filter.d.ts +4 -0
- package/dist/content-filter.js +16 -0
- package/dist/content-source.d.ts +100 -0
- package/dist/content-source.js +42 -0
- package/dist/content-workspace.d.ts +293 -0
- package/dist/content-workspace.js +69 -0
- package/dist/content.d.ts +41 -0
- package/dist/content.js +176 -0
- package/dist/cookbook-chooser.d.ts +19 -0
- package/dist/cookbook-chooser.js +56 -0
- package/dist/dev.d.ts +2 -0
- package/dist/dev.js +113 -0
- package/dist/diagram-svg.d.ts +1 -0
- package/dist/diagram-svg.js +44 -0
- package/dist/diagrams.d.ts +7 -0
- package/dist/diagrams.js +102 -0
- package/dist/docs-author.d.ts +86 -0
- package/dist/docs-author.js +380 -0
- package/dist/docs-command.d.ts +8 -0
- package/dist/docs-command.js +62 -0
- package/dist/docs-eval.d.ts +146 -0
- package/dist/docs-eval.js +231 -0
- package/dist/docs-mcp.d.ts +12 -0
- package/dist/docs-mcp.js +82 -0
- package/dist/docs-tool.d.ts +81 -0
- package/dist/docs-tool.js +7 -0
- package/dist/document-sync.d.ts +36 -0
- package/dist/document-sync.js +58 -0
- package/dist/documentation-core.d.ts +148 -0
- package/dist/documentation-core.js +160 -0
- package/dist/embeddings.d.ts +68 -0
- package/dist/embeddings.js +198 -0
- package/dist/focused-audit.d.ts +10 -0
- package/dist/focused-audit.js +69 -0
- package/dist/focused-openapi.d.ts +2 -0
- package/dist/focused-openapi.js +140 -0
- package/dist/fonts.d.ts +54 -0
- package/dist/fonts.js +92 -0
- package/dist/freshness.d.ts +7 -0
- package/dist/freshness.js +58 -0
- package/dist/frontmatter.d.ts +24 -0
- package/dist/frontmatter.js +342 -0
- package/dist/function-package.d.ts +1 -0
- package/dist/function-package.js +58 -0
- package/dist/highlight.d.ts +14 -0
- package/dist/highlight.js +114 -0
- package/dist/html-renderer.d.ts +10 -0
- package/dist/html-renderer.js +63 -0
- package/dist/icons.d.ts +8 -0
- package/dist/icons.js +40 -0
- package/dist/index-build.d.ts +55 -0
- package/dist/index-build.js +227 -0
- package/dist/ingredient-draft.d.ts +17 -0
- package/dist/ingredient-draft.js +94 -0
- package/dist/ingredient-workflow.d.ts +8 -0
- package/dist/ingredient-workflow.js +25 -0
- package/dist/init.d.ts +8 -0
- package/dist/init.js +66 -0
- package/dist/jev.d.ts +62 -0
- package/dist/jev.js +190 -0
- package/dist/link-audit.d.ts +12 -0
- package/dist/link-audit.js +146 -0
- package/dist/llms-discovery.d.ts +11 -0
- package/dist/llms-discovery.js +23 -0
- package/dist/markdown-sections.d.ts +15 -0
- package/dist/markdown-sections.js +60 -0
- package/dist/markdown-size.d.ts +7 -0
- package/dist/markdown-size.js +6 -0
- package/dist/mcp-analytics.d.ts +38 -0
- package/dist/mcp-analytics.js +35 -0
- package/dist/mcp-artifacts.d.ts +2 -0
- package/dist/mcp-artifacts.js +78 -0
- package/dist/mcp-client-metadata.d.ts +18 -0
- package/dist/mcp-client-metadata.js +69 -0
- package/dist/mcp-config.d.ts +23 -0
- package/dist/mcp-config.js +56 -0
- package/dist/mcp-http.d.ts +19 -0
- package/dist/mcp-http.js +157 -0
- package/dist/mcp-integrity.d.ts +3 -0
- package/dist/mcp-integrity.js +4 -0
- package/dist/mcp-node.d.ts +4 -0
- package/dist/mcp-node.js +68 -0
- package/dist/mcp-vercel-runtime.d.ts +3 -0
- package/dist/mcp-vercel-runtime.js +36 -0
- package/dist/mcp-vercel.d.ts +15 -0
- package/dist/mcp-vercel.js +65 -0
- package/dist/metadata-provider.d.ts +19 -0
- package/dist/metadata-provider.js +38 -0
- package/dist/negotiation.d.ts +10 -0
- package/dist/negotiation.js +35 -0
- package/dist/not-found.d.ts +16 -0
- package/dist/not-found.js +25 -0
- package/dist/output-commit.d.ts +1 -0
- package/dist/output-commit.js +133 -0
- package/dist/output-location.d.ts +3 -0
- package/dist/output-location.js +30 -0
- package/dist/page-materialization.d.ts +78 -0
- package/dist/page-materialization.js +132 -0
- package/dist/page-renderer.d.ts +71 -0
- package/dist/page-renderer.js +177 -0
- package/dist/palettes.d.ts +41 -0
- package/dist/palettes.js +160 -0
- package/dist/procedure-components.d.ts +2 -0
- package/dist/procedure-components.js +94 -0
- package/dist/project-navigation.d.ts +41 -0
- package/dist/project-navigation.js +190 -0
- package/dist/provider-http.d.ts +10 -0
- package/dist/provider-http.js +60 -0
- package/dist/publication-manifest.d.ts +229 -0
- package/dist/publication-manifest.js +53 -0
- package/dist/publication-plan.d.ts +34 -0
- package/dist/publication-plan.js +85 -0
- package/dist/publication-render.d.ts +71 -0
- package/dist/publication-render.js +92 -0
- package/dist/reader-filters.d.ts +30 -0
- package/dist/reader-filters.js +105 -0
- package/dist/recipe-draft.d.ts +17 -0
- package/dist/recipe-draft.js +147 -0
- package/dist/reference-audit.d.ts +18 -0
- package/dist/reference-audit.js +169 -0
- package/dist/remote-import.d.ts +62 -0
- package/dist/remote-import.js +292 -0
- package/dist/representation-tree.d.ts +3 -0
- package/dist/representation-tree.js +320 -0
- package/dist/retrieval-config.d.ts +30 -0
- package/dist/retrieval-config.js +83 -0
- package/dist/retrieval.d.ts +60 -0
- package/dist/retrieval.js +228 -0
- package/dist/scaffold.d.ts +39 -0
- package/dist/scaffold.js +167 -0
- package/dist/search-config.d.ts +8 -0
- package/dist/search-config.js +26 -0
- package/dist/search-handler.d.ts +16 -0
- package/dist/search-handler.js +111 -0
- package/dist/search-identifier.d.ts +3 -0
- package/dist/search-identifier.js +25 -0
- package/dist/search-literal.d.ts +1 -0
- package/dist/search-literal.js +28 -0
- package/dist/search-query.d.ts +54 -0
- package/dist/search-query.js +120 -0
- package/dist/search-results.d.ts +6 -0
- package/dist/search-results.js +45 -0
- package/dist/search-snippet.d.ts +11 -0
- package/dist/search-snippet.js +93 -0
- package/dist/search-synonyms.d.ts +8 -0
- package/dist/search-synonyms.js +46 -0
- package/dist/semantic-markdown.d.ts +10 -0
- package/dist/semantic-markdown.js +39 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.js +223 -0
- package/dist/share-images.d.ts +24 -0
- package/dist/share-images.js +187 -0
- package/dist/site-path.d.ts +2 -0
- package/dist/site-path.js +15 -0
- package/dist/sitemap.d.ts +8 -0
- package/dist/sitemap.js +58 -0
- package/dist/snippets.d.ts +19 -0
- package/dist/snippets.js +84 -0
- package/dist/structured-model-output.d.ts +6 -0
- package/dist/structured-model-output.js +21 -0
- package/dist/subject-deprecation.d.ts +21 -0
- package/dist/subject-deprecation.js +57 -0
- package/dist/surface-text.d.ts +4 -0
- package/dist/surface-text.js +42 -0
- package/dist/taxonomy.d.ts +14 -0
- package/dist/taxonomy.js +88 -0
- package/dist/turnstile.d.ts +21 -0
- package/dist/turnstile.js +52 -0
- package/dist/vale.d.ts +28 -0
- package/dist/vale.js +103 -0
- package/dist/vercel-function.d.ts +21 -0
- package/dist/vercel-function.js +108 -0
- package/dist/vercel.d.ts +11 -0
- package/dist/vercel.js +103 -0
- package/dist/walkthrough.d.ts +25 -0
- package/dist/walkthrough.js +336 -0
- package/dist/yaml-value.d.ts +2 -0
- package/dist/yaml-value.js +36 -0
- package/example-configs/api-docs/README.md +59 -0
- package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
- package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
- package/example-configs/api-docs/content/overview.mdx +36 -0
- package/example-configs/api-docs/content/quickstart.mdx +52 -0
- package/example-configs/api-docs/docs.config.yaml +104 -0
- package/example-configs/faceted-sites/README.md +31 -0
- package/example-configs/faceted-sites/base.yaml +30 -0
- package/example-configs/faceted-sites/content/api.md +12 -0
- package/example-configs/faceted-sites/content/home.md +10 -0
- package/example-configs/faceted-sites/content/operations.md +12 -0
- package/example-configs/faceted-sites/developers.config.yaml +8 -0
- package/example-configs/faceted-sites/docs.config.yaml +7 -0
- package/example-configs/faceted-sites/europe.config.yaml +9 -0
- package/example-configs/minimal/content/install.mdx +12 -0
- package/example-configs/minimal/content/welcome.mdx +8 -0
- package/example-configs/minimal/docs.config.yaml +31 -0
- package/example-configs/multilingual/content/de/home.mdx +9 -0
- package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
- package/example-configs/multilingual/content/home.mdx +10 -0
- package/example-configs/multilingual/content/reset-password.mdx +12 -0
- package/example-configs/multilingual/docs.config.yaml +61 -0
- package/example-configs/multilingual/snippets/contact.mdx +1 -0
- package/example-configs/notifications/apis/notifications.yaml +132 -0
- package/example-configs/notifications/content/cookbook.mdx +17 -0
- package/example-configs/notifications/content/get-message.mdx +14 -0
- package/example-configs/notifications/content/queue-email.mdx +42 -0
- package/example-configs/notifications/content/queue-push.mdx +33 -0
- package/example-configs/notifications/content/queue-sms.mdx +33 -0
- package/example-configs/notifications/content/send-email.mdx +14 -0
- package/example-configs/notifications/content/send-push.mdx +14 -0
- package/example-configs/notifications/content/send-sms.mdx +14 -0
- package/example-configs/notifications/content/start.mdx +13 -0
- package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
- package/example-configs/notifications/content/welcome-email.mdx +82 -0
- package/example-configs/notifications/demo.mjs +43 -0
- package/example-configs/notifications/docs.config.yaml +88 -0
- package/example-configs/notifications/ingredient-drafts/README.md +41 -0
- package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
- package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
- package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
- package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
- package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
- package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
- package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
- package/example-configs/reference-stress/README.md +32 -0
- package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
- package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
- package/example-configs/reference-stress/content/overview.mdx +14 -0
- package/example-configs/reference-stress/docs.config.yaml +55 -0
- package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
- package/example-configs/shared-preset/shared/runbook.mdx +7 -0
- package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
- package/example-configs/shared-preset/site/content/start.mdx +9 -0
- package/example-configs/shared-preset/site/docs.config.yaml +18 -0
- package/example-configs/showcase/README.md +20 -0
- package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
- package/example-configs/showcase/content/assets/collection.svg +1 -0
- package/example-configs/showcase/content/code.mdx +100 -0
- package/example-configs/showcase/content/create-enrollment.mdx +11 -0
- package/example-configs/showcase/content/features.mdx +39 -0
- package/example-configs/showcase/content/landing.mdx +36 -0
- package/example-configs/showcase/content/overview.mdx +42 -0
- package/example-configs/showcase/content/personalization.mdx +38 -0
- package/example-configs/showcase/content/preview.mdx +35 -0
- package/example-configs/showcase/content/procedures.mdx +88 -0
- package/example-configs/showcase/content/quickstart.mdx +64 -0
- package/example-configs/showcase/content/reading.mdx +99 -0
- package/example-configs/showcase/content/verify.mdx +27 -0
- package/example-configs/showcase/content/visuals.mdx +47 -0
- package/example-configs/showcase/content/workflows.mdx +12 -0
- package/example-configs/showcase/docs.config.yaml +149 -0
- package/example-configs/showcase/snippets/sandbox.mdx +1 -0
- package/examples/analytics/README.md +56 -0
- package/examples/analytics/inspector.js +25 -0
- package/examples/analytics/posthog.js +36 -0
- package/examples/components/comparison.mjs +8 -0
- package/examples/components/components.json +6 -0
- package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
- package/examples/components/copy-text/LICENSE.react.txt +21 -0
- package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
- package/examples/components/copy-text/browser.jsx +21 -0
- package/examples/components/copy-text/components.json +6 -0
- package/examples/components/copy-text/package-lock.json +41 -0
- package/examples/components/copy-text/package.json +9 -0
- package/examples/components/copy-text/plugin.mjs +5 -0
- package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
- package/examples/components/retry-budget/LICENSE.react.txt +21 -0
- package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
- package/examples/components/retry-budget/browser.jsx +50 -0
- package/examples/components/retry-budget/components.json +6 -0
- package/examples/components/retry-budget/model.js +22 -0
- package/examples/components/retry-budget/package-lock.json +41 -0
- package/examples/components/retry-budget/package.json +9 -0
- package/examples/components/retry-budget/plugin.mjs +31 -0
- package/examples/components/retry-budget/policy.json +9 -0
- package/examples/components/retry-budget/style.css +25 -0
- package/examples/diagrams/d2-gallery.json +138 -0
- package/examples/diagrams/gallery.json +236 -0
- package/examples/help-drawer/README.md +44 -0
- package/examples/help-drawer/app.js +53 -0
- package/examples/help-drawer/components/components.json +1 -0
- package/examples/help-drawer/components/support.mjs +10 -0
- package/examples/help-drawer/content/account.md +8 -0
- package/examples/help-drawer/content/billing.mdx +29 -0
- package/examples/help-drawer/content/keys.mdx +46 -0
- package/examples/help-drawer/content/settings.svg +1 -0
- package/examples/help-drawer/docs.config.yaml +30 -0
- package/examples/help-drawer/index.html +26 -0
- package/examples/help-drawer/preview.mjs +33 -0
- package/examples/mcp-analytics/README.md +59 -0
- package/examples/mcp-analytics/posthog.mjs +159 -0
- package/package.json +100 -4
- package/schemas/content-export.schema.json +55 -0
- package/skills/shoalrun-author/SKILL.md +52 -0
- package/skills/shoalrun-component-author/SKILL.md +24 -0
- package/skills/shoalrun-recipes/SKILL.md +25 -0
- package/skills/shoalrun-setup/SKILL.md +34 -0
- package/skills/shoalrun-walkthrough/SKILL.md +18 -0
- package/styles/fonts/figtree-LICENSE.txt +93 -0
- package/styles/fonts/figtree-italic.woff2 +0 -0
- package/styles/fonts/figtree.woff2 +0 -0
- package/styles/fonts/inter-LICENSE.txt +93 -0
- package/styles/fonts/inter-italic.woff2 +0 -0
- package/styles/fonts/inter.woff2 +0 -0
- package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
- package/styles/fonts/jetbrains-mono.woff2 +0 -0
- package/styles/fonts/jost-LICENSE.txt +93 -0
- package/styles/fonts/jost-italic.woff2 +0 -0
- package/styles/fonts/jost.woff2 +0 -0
- package/styles/fonts/share/figtree-400.ttf +0 -0
- package/styles/fonts/share/figtree-700.ttf +0 -0
- package/styles/fonts/share/inter-400.ttf +0 -0
- package/styles/fonts/share/inter-700.ttf +0 -0
- package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
- package/styles/fonts/share/jost-italic-800.ttf +0 -0
- package/styles/fonts/share/metrics.json +1 -0
- package/styles/fonts/share/source-serif-4-400.ttf +0 -0
- package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
- package/styles/fonts/source-serif-4-italic.woff2 +0 -0
- package/styles/fonts/source-serif-4.woff2 +0 -0
- package/styles/header.css +56 -0
- package/styles/site.css +825 -0
- package/styles/themes/ledger.css +93 -0
- package/styles/themes/palettes/amethyst.yaml +127 -0
- package/styles/themes/palettes/coral.yaml +127 -0
- package/styles/themes/palettes/harbor.yaml +127 -0
- package/styles/themes/palettes/ink.yaml +127 -0
- package/styles/themes/palettes/kelp.yaml +127 -0
- package/styles/themes/palettes/vice.yaml +127 -0
- package/styles/themes/reef.css +68 -0
- package/styles/themes/vice.css +56 -0
- package/styles/tokens.css +91 -0
- package/templates/api-reference.mdx +133 -0
- package/templates/cookbook.mdx +38 -0
- package/templates/explanation.mdx +76 -0
- package/templates/guide.mdx +175 -0
- package/templates/how-to.mdx +171 -0
- package/templates/ingredient.mdx +53 -0
- package/templates/recipe.mdx +76 -0
- package/templates/reference.mdx +171 -0
- package/templates/troubleshooting.mdx +159 -0
- package/templates/tutorial.mdx +165 -0
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
const cookbookInstances = new Map();
|
|
2
|
+
for (const [chooserIndex, chooser] of [...document.querySelectorAll('[data-cookbook-chooser]')].entries()) {
|
|
3
|
+
const controls = chooser.querySelector('.cookbook-chooser-controls');
|
|
4
|
+
const status = chooser.querySelector('.cookbook-chooser-status');
|
|
5
|
+
const result = chooser.querySelector('.cookbook-chooser-result');
|
|
6
|
+
const actions = chooser.querySelector('.cookbook-path-actions');
|
|
7
|
+
if (!controls || !status || !result || !actions) continue;
|
|
8
|
+
let config;
|
|
9
|
+
try { config = JSON.parse(chooser.getAttribute('data-cookbook-chooser')); }
|
|
10
|
+
catch { continue; }
|
|
11
|
+
const { options, mode, title } = config;
|
|
12
|
+
if (!Array.isArray(options)) continue;
|
|
13
|
+
const inputs = [...controls.querySelectorAll('input')];
|
|
14
|
+
const instance = cookbookInstances.get(config.id) ?? 0;
|
|
15
|
+
cookbookInstances.set(config.id, instance + 1);
|
|
16
|
+
const parameter = `cookbook.${config.id}.${instance}`;
|
|
17
|
+
for (const input of inputs) input.name = parameter;
|
|
18
|
+
const cache = new Map();
|
|
19
|
+
let revision = 0;
|
|
20
|
+
let selected = [];
|
|
21
|
+
const fetchText = (route, kind) => {
|
|
22
|
+
const key = `${kind}:${route}`;
|
|
23
|
+
if (!cache.has(key)) cache.set(key, fetch(route).then(response => {
|
|
24
|
+
if (!response.ok) throw new Error(`HTTP ${response.status}`);
|
|
25
|
+
return response.text();
|
|
26
|
+
}).catch(error => { cache.delete(key); throw error; }));
|
|
27
|
+
return cache.get(key);
|
|
28
|
+
};
|
|
29
|
+
const recipeArticle = async option => {
|
|
30
|
+
const html = await fetchText(option.route, 'html');
|
|
31
|
+
const page = new DOMParser().parseFromString(html, 'text/html');
|
|
32
|
+
const article = page.querySelector('main[data-document-type="recipe"] > article');
|
|
33
|
+
if (!article) throw new Error('Recipe content was not found');
|
|
34
|
+
return article;
|
|
35
|
+
};
|
|
36
|
+
const restore = () => {
|
|
37
|
+
const values = new URL(location.href).searchParams.get(parameter)?.split(',') ?? [];
|
|
38
|
+
let chosen = false;
|
|
39
|
+
for (const input of inputs) {
|
|
40
|
+
input.checked = values.includes(input.value) && (mode !== 'single' || !chosen);
|
|
41
|
+
chosen ||= input.checked;
|
|
42
|
+
}
|
|
43
|
+
};
|
|
44
|
+
const share = actions.querySelector('.cookbook-share');
|
|
45
|
+
const update = async (save = true) => {
|
|
46
|
+
const current = ++revision;
|
|
47
|
+
selected = options.filter(option => inputs.some(input => input.value === option.id && input.checked));
|
|
48
|
+
const currentSelection = selected;
|
|
49
|
+
const url = new URL(location.href);
|
|
50
|
+
if (selected.length) url.searchParams.set(parameter, selected.map(option => option.id).join(','));
|
|
51
|
+
else url.searchParams.delete(parameter);
|
|
52
|
+
if (save) history.replaceState(null, '', url);
|
|
53
|
+
share.href = url.href;
|
|
54
|
+
result.replaceChildren();
|
|
55
|
+
actions.hidden = true;
|
|
56
|
+
if (!selected.length) {
|
|
57
|
+
status.textContent = mode === 'single' ? 'Choose one recipe.' : 'Choose one or more recipes.';
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
status.textContent = 'Loading your path…';
|
|
61
|
+
const articles = await Promise.allSettled(selected.map(recipeArticle));
|
|
62
|
+
if (current !== revision) return;
|
|
63
|
+
const path = document.createElement('div');
|
|
64
|
+
path.className = 'cookbook-assembled-path';
|
|
65
|
+
const heading = document.createElement('h2');
|
|
66
|
+
heading.textContent = 'Your path';
|
|
67
|
+
path.append(heading);
|
|
68
|
+
for (const [index, option] of currentSelection.entries()) {
|
|
69
|
+
const step = document.createElement('section');
|
|
70
|
+
step.className = 'cookbook-assembled-recipe';
|
|
71
|
+
const heading = document.createElement('h3');
|
|
72
|
+
heading.textContent = `${index + 1}. ${option.title}`;
|
|
73
|
+
step.append(heading);
|
|
74
|
+
const source = document.createElement('p');
|
|
75
|
+
const sourceLink = document.createElement('a');
|
|
76
|
+
sourceLink.href = option.route;
|
|
77
|
+
sourceLink.textContent = 'Open the full recipe';
|
|
78
|
+
source.append(sourceLink);
|
|
79
|
+
step.append(source);
|
|
80
|
+
const article = articles[index];
|
|
81
|
+
if (article.status === 'fulfilled') {
|
|
82
|
+
const body = document.importNode(article.value, true);
|
|
83
|
+
for (const oldHeading of body.querySelectorAll('h1,h2,h3,h4,h5,h6')) {
|
|
84
|
+
const level = Math.min(Number(oldHeading.tagName.slice(1)) + 2, 6);
|
|
85
|
+
const newHeading = document.createElement(`h${level}`);
|
|
86
|
+
for (const attribute of oldHeading.attributes) newHeading.setAttribute(attribute.name, attribute.value);
|
|
87
|
+
newHeading.append(...oldHeading.childNodes);
|
|
88
|
+
oldHeading.replaceWith(newHeading);
|
|
89
|
+
}
|
|
90
|
+
const idMap = new Map();
|
|
91
|
+
for (const element of body.querySelectorAll('[id]')) {
|
|
92
|
+
const oldId = element.id;
|
|
93
|
+
const newId = `cookbook-${chooserIndex}-${option.id}-${oldId}`;
|
|
94
|
+
idMap.set(oldId, newId);
|
|
95
|
+
element.id = newId;
|
|
96
|
+
}
|
|
97
|
+
for (const element of body.querySelectorAll('[aria-labelledby],[aria-describedby],[aria-controls],[for]')) {
|
|
98
|
+
for (const name of ['aria-labelledby', 'aria-describedby', 'aria-controls', 'for']) {
|
|
99
|
+
if (element.hasAttribute(name)) element.setAttribute(name, element.getAttribute(name).split(/\s+/).map(id => idMap.get(id) ?? id).join(' '));
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
for (const element of body.querySelectorAll('[href],[src]')) {
|
|
103
|
+
for (const name of ['href', 'src']) {
|
|
104
|
+
const value = element.getAttribute(name);
|
|
105
|
+
if (!value) continue;
|
|
106
|
+
if (name === 'href' && value.startsWith('#')) {
|
|
107
|
+
let id;
|
|
108
|
+
try { id = decodeURIComponent(value.slice(1)); } catch { id = value.slice(1); }
|
|
109
|
+
if (idMap.has(id)) { element.setAttribute(name, `#${idMap.get(id)}`); continue; }
|
|
110
|
+
}
|
|
111
|
+
element.setAttribute(name, new URL(value, new URL(option.route, location.href)).href);
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
step.append(...body.childNodes);
|
|
115
|
+
} else {
|
|
116
|
+
const error = document.createElement('p');
|
|
117
|
+
error.textContent = 'This recipe could not be loaded here. Open the full recipe to continue, or select it again to retry.';
|
|
118
|
+
step.append(error);
|
|
119
|
+
}
|
|
120
|
+
path.append(step);
|
|
121
|
+
}
|
|
122
|
+
result.replaceChildren(path);
|
|
123
|
+
document.dispatchEvent(new CustomEvent('shoalrun:content', { detail: { root: chooser } }));
|
|
124
|
+
actions.hidden = false;
|
|
125
|
+
const failed = articles.some(article => article.status === 'rejected');
|
|
126
|
+
actions.querySelector('.cookbook-print').disabled = failed;
|
|
127
|
+
status.textContent = failed ? 'Some instructions could not be loaded. Open the full recipe or try again.' : `${selected.length} ${selected.length === 1 ? 'recipe' : 'recipes'} in your path.`;
|
|
128
|
+
};
|
|
129
|
+
const download = actions.querySelector('.cookbook-download');
|
|
130
|
+
download.addEventListener('click', async () => {
|
|
131
|
+
const current = revision;
|
|
132
|
+
const selection = [...selected];
|
|
133
|
+
download.disabled = true;
|
|
134
|
+
try {
|
|
135
|
+
const pages = await Promise.all(selection.map(option => fetchText(option.markdownRoute, 'markdown')));
|
|
136
|
+
if (current !== revision) return;
|
|
137
|
+
// Preserve the complete authored Markdown, including fenced code. Each recipe retains its own heading.
|
|
138
|
+
const markdown = pages.length === 1 ? pages[0] : `# ${title}\n\n${pages.map(page => page.replace(/^---\r?\n[\s\S]*?\r?\n---\r?\n/, '').trim()).join('\n\n---\n\n')}\n`;
|
|
139
|
+
const objectUrl = URL.createObjectURL(new Blob([markdown], { type: 'text/markdown;charset=utf-8' }));
|
|
140
|
+
const link = document.createElement('a');
|
|
141
|
+
link.href = objectUrl;
|
|
142
|
+
link.download = `${config.id}-${selection.map(option => option.id).join('-')}.md`;
|
|
143
|
+
document.body.append(link);
|
|
144
|
+
link.click();
|
|
145
|
+
link.remove();
|
|
146
|
+
setTimeout(() => URL.revokeObjectURL(objectUrl), 1000);
|
|
147
|
+
status.textContent = 'Your Markdown download is ready.';
|
|
148
|
+
} catch {
|
|
149
|
+
if (current === revision) status.textContent = 'Markdown could not be downloaded. Try again or open the full recipe.';
|
|
150
|
+
} finally { download.disabled = false; }
|
|
151
|
+
});
|
|
152
|
+
actions.querySelector('.cookbook-print').addEventListener('click', () => {
|
|
153
|
+
const sheet = document.createElement('div');
|
|
154
|
+
sheet.className = 'cookbook-print-sheet';
|
|
155
|
+
const heading = document.createElement('h1');
|
|
156
|
+
heading.textContent = title;
|
|
157
|
+
sheet.append(heading, result.cloneNode(true));
|
|
158
|
+
for (const details of sheet.querySelectorAll('details')) details.open = true;
|
|
159
|
+
document.body.append(sheet);
|
|
160
|
+
document.body.classList.add('cookbook-printing');
|
|
161
|
+
const cleanup = () => { sheet.remove(); document.body.classList.remove('cookbook-printing'); };
|
|
162
|
+
window.addEventListener('afterprint', cleanup, { once: true });
|
|
163
|
+
try { window.print(); } catch { cleanup(); }
|
|
164
|
+
});
|
|
165
|
+
for (const input of inputs) input.addEventListener('change', () => update());
|
|
166
|
+
window.addEventListener('popstate', () => { restore(); update(false); });
|
|
167
|
+
controls.hidden = false;
|
|
168
|
+
restore();
|
|
169
|
+
update(false);
|
|
170
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
const button = document.querySelector('[data-copy-markdown]');
|
|
2
|
+
const status = document.querySelector('[data-copy-markdown-status]');
|
|
3
|
+
const link = document.querySelector('.page-formats a');
|
|
4
|
+
if (button && status && link) {
|
|
5
|
+
button.hidden = false;
|
|
6
|
+
button.addEventListener('click', async () => {
|
|
7
|
+
if (button.getAttribute('aria-disabled') === 'true') return;
|
|
8
|
+
button.setAttribute('aria-disabled', 'true');
|
|
9
|
+
status.textContent = 'Copying Markdown…';
|
|
10
|
+
try {
|
|
11
|
+
if (!navigator.clipboard?.writeText) throw new Error('clipboard');
|
|
12
|
+
const response = await fetch(link.href);
|
|
13
|
+
if (!response.ok) throw new Error('fetch');
|
|
14
|
+
const markdown = await response.text();
|
|
15
|
+
await navigator.clipboard.writeText(markdown);
|
|
16
|
+
status.textContent = 'Markdown copied.';
|
|
17
|
+
globalThis.shoalrunAnalytics?.track('markdown_copy', {}, button);
|
|
18
|
+
} catch {
|
|
19
|
+
status.textContent = 'Could not copy Markdown. Open Read as Markdown to copy it manually.';
|
|
20
|
+
} finally {
|
|
21
|
+
button.removeAttribute('aria-disabled');
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
const panel = document.querySelector('.examples');
|
|
2
|
+
|
|
3
|
+
if (panel) {
|
|
4
|
+
const expandButton = panel.querySelector('.examples-expand');
|
|
5
|
+
const setExpanded = expanded => {
|
|
6
|
+
panel.classList.toggle('is-expanded', expanded);
|
|
7
|
+
panel.closest('.page-rail')?.classList.toggle('has-expanded-examples', expanded);
|
|
8
|
+
expandButton?.setAttribute('aria-pressed', String(expanded));
|
|
9
|
+
if (expandButton) expandButton.textContent = expanded ? 'Close wide view' : 'Expand';
|
|
10
|
+
};
|
|
11
|
+
expandButton?.addEventListener('click', () => setExpanded(!panel.classList.contains('is-expanded')));
|
|
12
|
+
addEventListener('keydown', event => {
|
|
13
|
+
if (event.key === 'Escape' && panel.classList.contains('is-expanded')) {
|
|
14
|
+
setExpanded(false);
|
|
15
|
+
expandButton?.focus();
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
const chooser = panel.querySelector('.api-view-control');
|
|
19
|
+
const select = panel.querySelector('#api-view-select');
|
|
20
|
+
const views = [...panel.querySelectorAll('[data-api-view]')];
|
|
21
|
+
const showView = value => {
|
|
22
|
+
for (const view of views) view.hidden = view.dataset.apiView !== value;
|
|
23
|
+
if (select) select.value = value;
|
|
24
|
+
};
|
|
25
|
+
if (chooser && select) {
|
|
26
|
+
showView('examples');
|
|
27
|
+
chooser.hidden = false;
|
|
28
|
+
select.addEventListener('change', () => showView(select.value));
|
|
29
|
+
}
|
|
30
|
+
const scenarios = [...panel.querySelectorAll('details[name]')];
|
|
31
|
+
const show = (selected, focus = false, scroll = true) => {
|
|
32
|
+
for (const scenario of scenarios) {
|
|
33
|
+
if (scenario.name === selected.name && scenario !== selected) scenario.open = false;
|
|
34
|
+
}
|
|
35
|
+
const group = selected.closest('.example-group[data-compact]');
|
|
36
|
+
if (group) {
|
|
37
|
+
for (const scenario of group.querySelectorAll('details[name]')) scenario.hidden = scenario !== selected;
|
|
38
|
+
const picker = group.querySelector('.example-picker select');
|
|
39
|
+
if (picker) picker.value = selected.id;
|
|
40
|
+
}
|
|
41
|
+
selected.open = true;
|
|
42
|
+
if (scroll) selected.scrollIntoView({ block: 'nearest' });
|
|
43
|
+
if (focus) selected.querySelector('summary')?.focus({ preventScroll: true });
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
for (const group of panel.querySelectorAll('.example-group[data-compact]')) {
|
|
47
|
+
const picker = group.querySelector('.example-picker');
|
|
48
|
+
const select = picker?.querySelector('select');
|
|
49
|
+
const entries = [...group.querySelectorAll('details[name]')];
|
|
50
|
+
if (!picker || !select || !entries.length) continue;
|
|
51
|
+
picker.hidden = false;
|
|
52
|
+
show(entries.find(entry => entry.open) ?? entries[0], false, false);
|
|
53
|
+
select.addEventListener('change', () => {
|
|
54
|
+
const selected = entries.find(entry => entry.id === select.value);
|
|
55
|
+
if (selected) show(selected);
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
for (const scenario of scenarios) {
|
|
60
|
+
scenario.addEventListener('toggle', () => {
|
|
61
|
+
if (scenario.open && (!chooser || select.value === 'examples')) show(scenario);
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
const revealHash = () => {
|
|
66
|
+
if (!location.hash) return;
|
|
67
|
+
let target;
|
|
68
|
+
try { target = document.getElementById(decodeURIComponent(location.hash.slice(1))); }
|
|
69
|
+
catch { return; }
|
|
70
|
+
if (target instanceof HTMLDetailsElement && panel.contains(target)) {
|
|
71
|
+
if (chooser) showView('examples');
|
|
72
|
+
show(target, true);
|
|
73
|
+
}
|
|
74
|
+
};
|
|
75
|
+
addEventListener('hashchange', revealHash);
|
|
76
|
+
revealHash();
|
|
77
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
// Native disclosures work without this enhancement; arrows add convenient navigation.
|
|
2
|
+
for (const root of document.querySelectorAll('[data-file-tree]')) {
|
|
3
|
+
const branches = [...root.querySelectorAll('.file-tree-branch')];
|
|
4
|
+
const controls = root.querySelector('.file-tree-controls');
|
|
5
|
+
if (controls && branches.length) {
|
|
6
|
+
controls.hidden = false;
|
|
7
|
+
controls.querySelector('[data-tree-expand]').addEventListener('click', () => branches.forEach(branch => { branch.open = true; }));
|
|
8
|
+
controls.querySelector('[data-tree-collapse]').addEventListener('click', () => branches.forEach(branch => { branch.open = false; }));
|
|
9
|
+
}
|
|
10
|
+
// Keep regular links and disclosure semantics rather than claiming an ARIA tree widget.
|
|
11
|
+
for (const label of root.querySelectorAll('.file-tree-file > .file-tree-label')) {
|
|
12
|
+
if (!label.querySelector('a')) label.tabIndex = 0;
|
|
13
|
+
}
|
|
14
|
+
const visibleNodes = () => [...root.querySelectorAll('summary, .file-tree-file > .file-tree-label > a, .file-tree-file > .file-tree-label[tabindex]')].filter(node => node.getClientRects().length);
|
|
15
|
+
let prefix = '', typedAt = 0;
|
|
16
|
+
root.addEventListener('keydown', event => {
|
|
17
|
+
if (event.altKey || event.ctrlKey || event.metaKey || (event.shiftKey && event.key.length !== 1)) return;
|
|
18
|
+
const target = event.target;
|
|
19
|
+
const nodes = visibleNodes();
|
|
20
|
+
const index = nodes.indexOf(target);
|
|
21
|
+
if (index < 0) return;
|
|
22
|
+
const branch = target.matches('summary') ? target.parentElement : null;
|
|
23
|
+
let next;
|
|
24
|
+
if (event.key === 'ArrowDown') next = nodes[Math.min(index + 1, nodes.length - 1)];
|
|
25
|
+
else if (event.key === 'ArrowUp') next = nodes[Math.max(index - 1, 0)];
|
|
26
|
+
else if (event.key === 'Home') next = nodes[0];
|
|
27
|
+
else if (event.key === 'End') next = nodes.at(-1);
|
|
28
|
+
else if (event.key === 'ArrowRight' && branch) {
|
|
29
|
+
if (!branch.open) branch.open = true;
|
|
30
|
+
else next = nodes[index + 1];
|
|
31
|
+
} else if (event.key === 'ArrowLeft') {
|
|
32
|
+
if (branch?.open) branch.open = false;
|
|
33
|
+
else next = (branch?.parentElement ?? target).parentElement.closest('.file-tree-branch')?.querySelector(':scope > summary');
|
|
34
|
+
} else if (event.key === '*') {
|
|
35
|
+
const siblings = target.closest('li')?.parentElement;
|
|
36
|
+
siblings?.querySelectorAll(':scope > li > .file-tree-branch').forEach(folder => { folder.open = true; });
|
|
37
|
+
} else if (event.key.length === 1 && event.key !== ' ') {
|
|
38
|
+
const now = Date.now();
|
|
39
|
+
prefix = now - typedAt > 700 ? event.key.toLocaleLowerCase() : prefix + event.key.toLocaleLowerCase();
|
|
40
|
+
typedAt = now;
|
|
41
|
+
const find = value => [...nodes.slice(index + 1), ...nodes.slice(0, index + 1)].find(node => node.textContent.trim().toLocaleLowerCase().startsWith(value));
|
|
42
|
+
next = find(prefix);
|
|
43
|
+
if (!next && prefix.length > 1) { prefix = event.key.toLocaleLowerCase(); next = find(prefix); }
|
|
44
|
+
if (!next) return;
|
|
45
|
+
} else return;
|
|
46
|
+
event.preventDefault();
|
|
47
|
+
next?.focus();
|
|
48
|
+
});
|
|
49
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Links remain normal original-image links when modal dialogs are unavailable.
|
|
2
|
+
if (typeof HTMLDialogElement !== 'undefined' && typeof HTMLDialogElement.prototype.showModal === 'function') {
|
|
3
|
+
let dialog, image, caption, origin;
|
|
4
|
+
const prepare = () => {
|
|
5
|
+
if (dialog) return;
|
|
6
|
+
dialog = document.createElement('dialog');
|
|
7
|
+
dialog.className = 'doc-image-viewer';
|
|
8
|
+
dialog.setAttribute('aria-label', 'Expanded image');
|
|
9
|
+
const close = document.createElement('button');
|
|
10
|
+
close.type = 'button';
|
|
11
|
+
close.className = 'image-viewer-close';
|
|
12
|
+
close.textContent = '×';
|
|
13
|
+
close.setAttribute('aria-label', 'Close image');
|
|
14
|
+
close.title = 'Close image';
|
|
15
|
+
close.addEventListener('click', () => dialog.close());
|
|
16
|
+
image = document.createElement('img');
|
|
17
|
+
caption = document.createElement('p');
|
|
18
|
+
caption.className = 'image-viewer-caption';
|
|
19
|
+
dialog.append(close, image, caption);
|
|
20
|
+
document.body.append(dialog);
|
|
21
|
+
dialog.addEventListener('close', () => { if (origin?.isConnected) origin.focus(); });
|
|
22
|
+
dialog.addEventListener('click', event => {
|
|
23
|
+
const bounds = dialog.getBoundingClientRect();
|
|
24
|
+
if (event.target === dialog && (event.clientX < bounds.left || event.clientX > bounds.right || event.clientY < bounds.top || event.clientY > bounds.bottom)) dialog.close();
|
|
25
|
+
});
|
|
26
|
+
};
|
|
27
|
+
for (const link of document.querySelectorAll('a[data-image-expand]')) {
|
|
28
|
+
link.setAttribute('aria-haspopup', 'dialog');
|
|
29
|
+
link.addEventListener('click', event => {
|
|
30
|
+
if (event.button || event.ctrlKey || event.metaKey || event.shiftKey || event.altKey) return;
|
|
31
|
+
event.preventDefault();
|
|
32
|
+
prepare();
|
|
33
|
+
origin = link;
|
|
34
|
+
image.src = link.href;
|
|
35
|
+
image.alt = link.querySelector('img')?.alt ?? '';
|
|
36
|
+
caption.textContent = link.closest('figure')?.querySelector('figcaption')?.textContent ?? image.alt;
|
|
37
|
+
caption.hidden = !caption.textContent;
|
|
38
|
+
dialog.showModal();
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
}
|
package/assets/mode.js
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
// Loaded in <head> without defer so a saved choice applies before first paint.
|
|
2
|
+
// data-mode on <html> overrides the reader's OS preference; without it, prefers-color-scheme decides.
|
|
3
|
+
(() => {
|
|
4
|
+
const key = 'shoalrun-color-mode';
|
|
5
|
+
const root = document.documentElement;
|
|
6
|
+
const read = () => { try { return localStorage.getItem(key); } catch { return null; } };
|
|
7
|
+
const saved = read();
|
|
8
|
+
if (saved === 'light' || saved === 'dark') root.dataset.mode = saved;
|
|
9
|
+
const system = matchMedia('(prefers-color-scheme: dark)');
|
|
10
|
+
const isDark = () => root.dataset.mode ? root.dataset.mode === 'dark' : system.matches;
|
|
11
|
+
|
|
12
|
+
document.addEventListener('DOMContentLoaded', () => {
|
|
13
|
+
const toggle = document.querySelector('.mode-toggle');
|
|
14
|
+
if (!toggle) return;
|
|
15
|
+
const sync = () => toggle.setAttribute('aria-pressed', String(isDark()));
|
|
16
|
+
toggle.hidden = false;
|
|
17
|
+
sync();
|
|
18
|
+
system.addEventListener('change', sync);
|
|
19
|
+
toggle.addEventListener('click', () => {
|
|
20
|
+
const next = isDark() ? 'light' : 'dark';
|
|
21
|
+
root.dataset.mode = next;
|
|
22
|
+
try { localStorage.setItem(key, next); } catch {}
|
|
23
|
+
sync();
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
})();
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
const navigation = document.querySelector('.side');
|
|
2
|
+
const tree = navigation?.querySelector('.nav-tree');
|
|
3
|
+
const search = navigation?.querySelector('.nav-search');
|
|
4
|
+
const filter = navigation?.querySelector('#nav-filter');
|
|
5
|
+
if (filter) filter.placeholder = 'Find a page…';
|
|
6
|
+
const mobile = matchMedia('(max-width: 72rem)');
|
|
7
|
+
const sections = document.querySelector('.section-nav');
|
|
8
|
+
const outline = document.querySelector('.page-toc');
|
|
9
|
+
const outlineSlot = document.querySelector('.mobile-outline-slot');
|
|
10
|
+
const outlineHome = outline ? document.createComment('Page outline') : null;
|
|
11
|
+
outline?.before(outlineHome);
|
|
12
|
+
const menuLink = document.querySelector('.mobile-menu');
|
|
13
|
+
let openMenu;
|
|
14
|
+
|
|
15
|
+
// Keep one copy of each navigation region. The static document stays readable
|
|
16
|
+
// without scripts; only the enhanced mobile UI moves navigation into a dialog.
|
|
17
|
+
if (menuLink && typeof HTMLDialogElement !== 'undefined' && HTMLDialogElement.prototype.showModal) {
|
|
18
|
+
const regions = [sections, navigation].filter(Boolean).map(node => {
|
|
19
|
+
const home = document.createComment('Navigation region');
|
|
20
|
+
node.before(home);
|
|
21
|
+
return { node, home };
|
|
22
|
+
});
|
|
23
|
+
const menu = document.createElement('button');
|
|
24
|
+
menu.type = 'button';
|
|
25
|
+
menu.className = menuLink.className;
|
|
26
|
+
menu.textContent = 'Menu';
|
|
27
|
+
menu.setAttribute('aria-haspopup', 'dialog');
|
|
28
|
+
menu.setAttribute('aria-controls', 'documentation-menu');
|
|
29
|
+
menu.setAttribute('aria-expanded', 'false');
|
|
30
|
+
menuLink.replaceWith(menu);
|
|
31
|
+
const dialog = document.createElement('dialog');
|
|
32
|
+
dialog.id = 'documentation-menu';
|
|
33
|
+
dialog.className = 'navigation-dialog';
|
|
34
|
+
dialog.setAttribute('aria-label', 'Documentation navigation');
|
|
35
|
+
const header = document.createElement('div');
|
|
36
|
+
header.className = 'navigation-dialog-header';
|
|
37
|
+
const title = document.createElement('strong');
|
|
38
|
+
title.textContent = 'Documentation';
|
|
39
|
+
const close = document.createElement('button');
|
|
40
|
+
close.type = 'button';
|
|
41
|
+
close.textContent = 'Close';
|
|
42
|
+
close.setAttribute('aria-label', 'Close navigation');
|
|
43
|
+
close.autofocus = true;
|
|
44
|
+
header.append(title, close);
|
|
45
|
+
dialog.append(header);
|
|
46
|
+
document.body.append(dialog);
|
|
47
|
+
let readingPosition;
|
|
48
|
+
let opener;
|
|
49
|
+
const finishClose = (restoreFocus = true) => {
|
|
50
|
+
if (!readingPosition) return;
|
|
51
|
+
document.documentElement.classList.remove('navigation-open');
|
|
52
|
+
menu.setAttribute('aria-expanded', 'false');
|
|
53
|
+
if (restoreFocus) (opener?.isConnected ? opener : menu).focus({ preventScroll: true });
|
|
54
|
+
window.scrollTo({ ...readingPosition, behavior: 'instant' });
|
|
55
|
+
readingPosition = null;
|
|
56
|
+
opener = null;
|
|
57
|
+
};
|
|
58
|
+
const closeMenu = (restoreFocus = true) => {
|
|
59
|
+
if (dialog.open) dialog.close();
|
|
60
|
+
finishClose(restoreFocus);
|
|
61
|
+
};
|
|
62
|
+
openMenu = (trigger = menu) => {
|
|
63
|
+
if (!mobile.matches || dialog.open) return;
|
|
64
|
+
readingPosition = { left: scrollX, top: scrollY };
|
|
65
|
+
opener = trigger;
|
|
66
|
+
document.documentElement.classList.add('navigation-open');
|
|
67
|
+
menu.setAttribute('aria-expanded', 'true');
|
|
68
|
+
dialog.showModal();
|
|
69
|
+
// Reveal the current page without moving the underlying article.
|
|
70
|
+
const current = tree?.querySelector('[aria-current="page"]');
|
|
71
|
+
if (current) {
|
|
72
|
+
const top = header.getBoundingClientRect().bottom;
|
|
73
|
+
const rect = current.getBoundingClientRect();
|
|
74
|
+
if (rect.top < top || rect.bottom > innerHeight) dialog.scrollTop += rect.top - top - 16;
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
menu.addEventListener('click', () => openMenu(menu));
|
|
78
|
+
close.addEventListener('click', () => closeMenu());
|
|
79
|
+
dialog.addEventListener('cancel', event => { event.preventDefault(); closeMenu(); });
|
|
80
|
+
dialog.addEventListener('close', () => { if (!dialog.open) finishClose(); });
|
|
81
|
+
dialog.addEventListener('keydown', event => {
|
|
82
|
+
// Filtering consumes the first Escape; the next closes navigation.
|
|
83
|
+
if (event.key === 'Escape' && !event.defaultPrevented) {
|
|
84
|
+
event.preventDefault();
|
|
85
|
+
closeMenu();
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
const outside = event => {
|
|
89
|
+
const rect = dialog.getBoundingClientRect();
|
|
90
|
+
return event.target === dialog && (event.clientX < rect.left || event.clientX >= rect.right || event.clientY < rect.top || event.clientY >= rect.bottom);
|
|
91
|
+
};
|
|
92
|
+
let backdropPress = false;
|
|
93
|
+
dialog.addEventListener('pointerdown', event => { backdropPress = outside(event); });
|
|
94
|
+
dialog.addEventListener('click', event => {
|
|
95
|
+
if (backdropPress && outside(event)) closeMenu();
|
|
96
|
+
backdropPress = false;
|
|
97
|
+
});
|
|
98
|
+
const updateMenu = () => {
|
|
99
|
+
const active = document.activeElement;
|
|
100
|
+
const inRegion = regions.some(({ node }) => node.contains(active));
|
|
101
|
+
if (mobile.matches) {
|
|
102
|
+
for (const { node } of regions) {
|
|
103
|
+
dialog.append(node);
|
|
104
|
+
const disclosure = node.querySelector(':scope > details');
|
|
105
|
+
if (disclosure) disclosure.open = true;
|
|
106
|
+
}
|
|
107
|
+
// Do not hide a focused desktop control when shrinking the viewport.
|
|
108
|
+
if (inRegion) {
|
|
109
|
+
openMenu(menu);
|
|
110
|
+
const target = active.matches('.nav-disclosure > summary') ? close : active;
|
|
111
|
+
target.focus({ preventScroll: true });
|
|
112
|
+
}
|
|
113
|
+
} else {
|
|
114
|
+
closeMenu(false);
|
|
115
|
+
for (const { node, home } of regions) {
|
|
116
|
+
home.after(node);
|
|
117
|
+
const disclosure = node.querySelector(':scope > details');
|
|
118
|
+
if (disclosure) disclosure.open = true;
|
|
119
|
+
}
|
|
120
|
+
if (inRegion) active.focus({ preventScroll: true });
|
|
121
|
+
else if (active === menu || dialog.contains(active)) (navigation ?? sections).focus({ preventScroll: true });
|
|
122
|
+
}
|
|
123
|
+
};
|
|
124
|
+
updateMenu();
|
|
125
|
+
mobile.addEventListener('change', updateMenu);
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
const updateOutline = () => {
|
|
129
|
+
if (!outline || !outlineSlot) return;
|
|
130
|
+
const active = document.activeElement;
|
|
131
|
+
const focused = outline.contains(active);
|
|
132
|
+
if (mobile.matches) outlineSlot.append(outline);
|
|
133
|
+
else outlineHome.after(outline);
|
|
134
|
+
outline.querySelector('details').open = !mobile.matches || focused;
|
|
135
|
+
if (focused) active.focus({ preventScroll: true });
|
|
136
|
+
};
|
|
137
|
+
updateOutline();
|
|
138
|
+
mobile.addEventListener('change', updateOutline);
|
|
139
|
+
|
|
140
|
+
// Real fragment links remain the no-script fallback. Desktop skip links reveal
|
|
141
|
+
// individually on focus, without inserting a new row into the reading layout.
|
|
142
|
+
for (const link of document.querySelectorAll('[data-region-jump], [data-region-return]')) {
|
|
143
|
+
link.addEventListener('click', event => {
|
|
144
|
+
if (event.defaultPrevented || event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) return;
|
|
145
|
+
const region = document.getElementById(link.hash.slice(1));
|
|
146
|
+
if (!region) return;
|
|
147
|
+
if (region === navigation && mobile.matches && openMenu) {
|
|
148
|
+
event.preventDefault();
|
|
149
|
+
openMenu(link);
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
const disclosure = region.querySelector(':scope > details');
|
|
153
|
+
if (disclosure) disclosure.open = true;
|
|
154
|
+
region.focus({ preventScroll: true });
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
outline?.addEventListener('keydown', event => {
|
|
158
|
+
if (event.key !== 'Escape' || event.defaultPrevented || !mobile.matches) return;
|
|
159
|
+
const disclosure = outline.querySelector('details');
|
|
160
|
+
if (!disclosure.open) return;
|
|
161
|
+
event.preventDefault();
|
|
162
|
+
disclosure.querySelector('summary').focus({ preventScroll: true });
|
|
163
|
+
disclosure.open = false;
|
|
164
|
+
});
|
|
165
|
+
outline?.addEventListener('click', event => {
|
|
166
|
+
const link = event.target.closest('li a[href^="#"]');
|
|
167
|
+
if (!link || !mobile.matches || event.defaultPrevented || event.button !== 0 || event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) return;
|
|
168
|
+
const heading = document.getElementById(decodeURIComponent(link.hash.slice(1)));
|
|
169
|
+
if (!heading) return;
|
|
170
|
+
// Collapse before the native anchor scroll, so the destination does not move.
|
|
171
|
+
outline.querySelector('details').open = false;
|
|
172
|
+
if (!heading.hasAttribute('tabindex')) {
|
|
173
|
+
heading.tabIndex = -1;
|
|
174
|
+
heading.addEventListener('blur', () => heading.removeAttribute('tabindex'), { once: true });
|
|
175
|
+
}
|
|
176
|
+
heading.focus({ preventScroll: true });
|
|
177
|
+
});
|
|
178
|
+
|
|
179
|
+
if (tree && search && filter) {
|
|
180
|
+
search.hidden = false;
|
|
181
|
+
const entries = [...tree.querySelectorAll('.nav-entry')];
|
|
182
|
+
const groups = [...tree.querySelectorAll('.nav-group')];
|
|
183
|
+
const status = search.querySelector('.nav-filter-status');
|
|
184
|
+
let beforeFilter = null;
|
|
185
|
+
|
|
186
|
+
const current = tree.querySelector('[aria-current="page"]');
|
|
187
|
+
if (current && !mobile.matches) {
|
|
188
|
+
const visibleTop = navigation.querySelector('.nav-tools').getBoundingClientRect().bottom + 8;
|
|
189
|
+
const visibleBottom = navigation.getBoundingClientRect().bottom - 8;
|
|
190
|
+
const position = current.getBoundingClientRect();
|
|
191
|
+
const group = current.closest('.nav-group')?.querySelector(':scope > details > summary');
|
|
192
|
+
const groupTop = group?.getBoundingClientRect().top ?? position.top;
|
|
193
|
+
const canShowGroup = position.bottom - groupTop <= visibleBottom - visibleTop;
|
|
194
|
+
if (position.top < visibleTop || position.bottom > visibleBottom || (canShowGroup && groupTop < visibleTop)) {
|
|
195
|
+
const targetTop = canShowGroup ? groupTop : position.bottom > visibleBottom ? position.bottom - (visibleBottom - visibleTop) : position.top;
|
|
196
|
+
navigation.scrollTop += targetTop - visibleTop;
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
const update = () => {
|
|
201
|
+
const terms = filter.value.trim().toLocaleLowerCase().split(/\s+/).filter(Boolean);
|
|
202
|
+
if (terms.length && !beforeFilter) beforeFilter = new Map(groups.map(group => [group, group.querySelector(':scope > details').open]));
|
|
203
|
+
let found = 0;
|
|
204
|
+
for (const entry of entries) {
|
|
205
|
+
const haystack = entry.dataset.search.toLocaleLowerCase();
|
|
206
|
+
const match = entry.dataset.readerHidden !== 'true' && terms.every(term => haystack.includes(term));
|
|
207
|
+
entry.hidden = !match;
|
|
208
|
+
if (match) found += 1;
|
|
209
|
+
}
|
|
210
|
+
for (const group of [...groups].reverse()) {
|
|
211
|
+
const count = [...group.querySelectorAll('.nav-entry')].filter(entry => !entry.hidden).length;
|
|
212
|
+
group.hidden = count === 0;
|
|
213
|
+
const countLabel = group.querySelector(':scope > details > summary .nav-count');
|
|
214
|
+
if (countLabel) countLabel.textContent = String(count);
|
|
215
|
+
const details = group.querySelector(':scope > details');
|
|
216
|
+
if (terms.length) details.open = count > 0;
|
|
217
|
+
else if (beforeFilter) details.open = beforeFilter.get(group);
|
|
218
|
+
}
|
|
219
|
+
if (!terms.length) beforeFilter = null;
|
|
220
|
+
status.textContent = terms.length ? `${found} ${found === 1 ? 'result' : 'results'}` : '';
|
|
221
|
+
};
|
|
222
|
+
|
|
223
|
+
filter.addEventListener('input', update);
|
|
224
|
+
document.addEventListener('reader-view-change', update);
|
|
225
|
+
update();
|
|
226
|
+
filter.addEventListener('keydown', event => {
|
|
227
|
+
if (event.key === 'Escape' && filter.value) {
|
|
228
|
+
filter.value = '';
|
|
229
|
+
update();
|
|
230
|
+
event.preventDefault();
|
|
231
|
+
}
|
|
232
|
+
});
|
|
233
|
+
}
|