@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,697 @@
|
|
|
1
|
+
import { lowerComponent } from './component-plugins.js';
|
|
2
|
+
import { cardComponent } from './cards.js';
|
|
3
|
+
import { cookbookChooserComponent } from './cookbook-chooser.js';
|
|
4
|
+
import { calloutIcon, validateLucideIcon } from './icons.js';
|
|
5
|
+
import { resolveCalloutTypes } from './callouts.js';
|
|
6
|
+
import { resolveBadgeVariants } from './badges.js';
|
|
7
|
+
import { apiEmbedComponent } from './api-embeds.js';
|
|
8
|
+
import { createHash } from 'node:crypto';
|
|
9
|
+
import { existsSync } from 'node:fs';
|
|
10
|
+
import path from 'node:path';
|
|
11
|
+
import katex from 'katex';
|
|
12
|
+
import { snippetAttribute, resolveSnippetValues } from './snippets.js';
|
|
13
|
+
import { frontmatterReference } from './frontmatter.js';
|
|
14
|
+
import { validateReaderFilterControl, validateReaderSelection } from './reader-filters.js';
|
|
15
|
+
import { walkthroughComponent } from './walkthrough.js';
|
|
16
|
+
import { procedureComponent } from './procedure-components.js';
|
|
17
|
+
import { parsePlainMarkdown, paragraph, link, text } from './semantic-markdown.js';
|
|
18
|
+
function isMdxRoot(tree) {
|
|
19
|
+
return !!tree && typeof tree === 'object'
|
|
20
|
+
&& tree.type === 'root'
|
|
21
|
+
&& Array.isArray(tree.children);
|
|
22
|
+
}
|
|
23
|
+
function isMdxInputNode(value) {
|
|
24
|
+
if (!value || typeof value !== 'object' || Array.isArray(value))
|
|
25
|
+
return false;
|
|
26
|
+
const node = value;
|
|
27
|
+
if (typeof node.type !== 'string')
|
|
28
|
+
return false;
|
|
29
|
+
if (node.name !== undefined && typeof node.name !== 'string')
|
|
30
|
+
return false;
|
|
31
|
+
if (node.value !== undefined && typeof node.value !== 'string' && typeof node.value !== 'number')
|
|
32
|
+
return false;
|
|
33
|
+
if (node.url !== undefined && typeof node.url !== 'string')
|
|
34
|
+
return false;
|
|
35
|
+
if (node.lang !== undefined && node.lang !== null && typeof node.lang !== 'string')
|
|
36
|
+
return false;
|
|
37
|
+
if (node.children !== undefined && (!Array.isArray(node.children) || !node.children.every(isMdxInputNode)))
|
|
38
|
+
return false;
|
|
39
|
+
if (node.attributes !== undefined && (!Array.isArray(node.attributes) || !node.attributes.every(isMdxAttribute)))
|
|
40
|
+
return false;
|
|
41
|
+
return true;
|
|
42
|
+
}
|
|
43
|
+
function isMdxAttribute(value) {
|
|
44
|
+
if (!value || typeof value !== 'object' || Array.isArray(value))
|
|
45
|
+
return false;
|
|
46
|
+
const item = value;
|
|
47
|
+
if (typeof item.name !== 'string')
|
|
48
|
+
return false;
|
|
49
|
+
if (item.type === 'mdxJsxAttribute') {
|
|
50
|
+
return typeof item.value === 'string' || item.value === null
|
|
51
|
+
|| !!item.value && typeof item.value === 'object' && !Array.isArray(item.value);
|
|
52
|
+
}
|
|
53
|
+
return item.type === 'mdxJsxExpressionAttribute' && typeof item.value === 'string';
|
|
54
|
+
}
|
|
55
|
+
function literalAttributes(attributes) {
|
|
56
|
+
return attributes.every(item => item.type === 'mdxJsxAttribute' && typeof item.value === 'string');
|
|
57
|
+
}
|
|
58
|
+
export function transformMdx(tree, current, registry, snippets = new Map(), projectValues = {}, uses = [], calloutTypes = resolveCalloutTypes(undefined, current.file), projectRoot, readerConfig, frontmatterConfig = {}, publicationConfig, badgeVariants = resolveBadgeVariants(undefined, current.file), componentPlugins = new Map()) {
|
|
59
|
+
if (!isMdxRoot(tree))
|
|
60
|
+
throw new Error(`${current.file}: parsed content must be a root with children`);
|
|
61
|
+
let pluginDepth = 0;
|
|
62
|
+
let tabsIndex = 0;
|
|
63
|
+
let walkthroughIndex = 0;
|
|
64
|
+
const imageReferences = new Map();
|
|
65
|
+
const collectImageReferences = (value, file) => {
|
|
66
|
+
const references = new Set();
|
|
67
|
+
const visit = (node) => {
|
|
68
|
+
if (!isMdxInputNode(node))
|
|
69
|
+
return;
|
|
70
|
+
if (node.type === 'imageReference' && typeof node.identifier === 'string')
|
|
71
|
+
references.add(node.identifier);
|
|
72
|
+
node.children?.forEach(visit);
|
|
73
|
+
};
|
|
74
|
+
visit(value);
|
|
75
|
+
imageReferences.set(file, references);
|
|
76
|
+
};
|
|
77
|
+
collectImageReferences(tree, current.file);
|
|
78
|
+
for (const snippet of snippets.values())
|
|
79
|
+
collectImageReferences(snippet.tree, snippet.file);
|
|
80
|
+
function attr(node, key) {
|
|
81
|
+
const item = node.attributes?.find(x => x.name === key);
|
|
82
|
+
if (!item || typeof item.value !== 'string')
|
|
83
|
+
throw new Error(`${current.file}: <${node.name}> needs literal ${key}`);
|
|
84
|
+
return item.value;
|
|
85
|
+
}
|
|
86
|
+
const childrenOf = (nodes, scope, stack, sourceFile) => nodes.flatMap(node => {
|
|
87
|
+
const result = walk(node, scope, stack, sourceFile);
|
|
88
|
+
return result === null ? [] : Array.isArray(result) ? result : [result];
|
|
89
|
+
});
|
|
90
|
+
function walk(input, scope, stack, sourceFile) {
|
|
91
|
+
if (!isMdxInputNode(input))
|
|
92
|
+
throw new Error(`${sourceFile}: parsed content has an invalid node`);
|
|
93
|
+
const node = input;
|
|
94
|
+
if (node.type === 'mdxjsEsm' && /^import\s+/.test(String(node.value ?? '')))
|
|
95
|
+
return null;
|
|
96
|
+
if (node.type === 'mdxFlowExpression' || node.type === 'mdxTextExpression' || node.type === 'mdxjsEsm')
|
|
97
|
+
throw new Error(`${sourceFile}: dynamic MDX expression has no semantic adapter`);
|
|
98
|
+
if (node.type === 'heading' && stack.length)
|
|
99
|
+
throw new Error(`${sourceFile}: snippet headings need an anchor adapter; put headings in the page`);
|
|
100
|
+
if (node.type === 'mdxJsxFlowElement' || node.type === 'mdxJsxTextElement') {
|
|
101
|
+
if (node.name && componentPlugins.has(node.name)) {
|
|
102
|
+
const start = node.position?.start;
|
|
103
|
+
const location = `${sourceFile}${start ? `:${start.line}:${start.column}` : ''}: <${node.name}>`;
|
|
104
|
+
if (++pluginDepth > 32)
|
|
105
|
+
throw new Error(`${location}: component lowering exceeded 32 nested expansions`);
|
|
106
|
+
try {
|
|
107
|
+
const result = lowerComponent(node, componentPlugins, location);
|
|
108
|
+
const children = childrenOf(result.nodes, scope, stack, sourceFile);
|
|
109
|
+
const browser = componentPlugins.get(node.name).browser;
|
|
110
|
+
if (browser && node.type !== 'mdxJsxFlowElement')
|
|
111
|
+
throw new Error(`${location}: browser-enhanced components must be block elements`);
|
|
112
|
+
return browser ? { type: 'docComponent', name: node.name, browser, componentData: result.data, children } : children;
|
|
113
|
+
}
|
|
114
|
+
catch (error) {
|
|
115
|
+
const message = error.message;
|
|
116
|
+
if (message.startsWith(location))
|
|
117
|
+
throw error;
|
|
118
|
+
throw new Error(`${location}: ${message}`);
|
|
119
|
+
}
|
|
120
|
+
finally {
|
|
121
|
+
pluginDepth--;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
if (node.name === 'FrontmatterReference') {
|
|
125
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length || node.attributes?.length)
|
|
126
|
+
throw new Error(`${sourceFile}: <FrontmatterReference> must be an empty block`);
|
|
127
|
+
return childrenOf(parsePlainMarkdown(frontmatterReference(frontmatterConfig, true)), scope, stack, sourceFile);
|
|
128
|
+
}
|
|
129
|
+
if (node.name === 'ForPublication') {
|
|
130
|
+
const attributes = node.attributes ?? [];
|
|
131
|
+
const allowed = ['channel', 'version', 'language'];
|
|
132
|
+
if (node.type !== 'mdxJsxFlowElement' || !node.children?.length || !attributes.length || !literalAttributes(attributes) || attributes.some((item) => !allowed.includes(item.name) || !item.value.trim()) || new Set(attributes.map((item) => item.name)).size !== attributes.length) {
|
|
133
|
+
throw new Error(`${sourceFile}: <ForPublication> needs block content and distinct literal channel, version, or language attributes`);
|
|
134
|
+
}
|
|
135
|
+
for (const item of attributes)
|
|
136
|
+
if ((item.name === 'channel' || item.name === 'version') && publicationConfig && !Object.hasOwn(publicationConfig[item.name === 'channel' ? 'channels' : 'versions'], item.value)) {
|
|
137
|
+
throw new Error(`${sourceFile}: <ForPublication> names unknown ${item.name} ${item.value}`);
|
|
138
|
+
}
|
|
139
|
+
if (attributes.some((item) => current.variant[item.name] !== item.value))
|
|
140
|
+
return [];
|
|
141
|
+
return childrenOf(node.children, scope, stack, sourceFile);
|
|
142
|
+
}
|
|
143
|
+
if (node.name === 'ReaderSection' || node.name === 'ReaderChoice' || node.name === 'ReaderFilter') {
|
|
144
|
+
if (!readerConfig || node.type !== 'mdxJsxFlowElement')
|
|
145
|
+
throw new Error(`${sourceFile}: <${node.name}> needs configured readerFilters and a block element`);
|
|
146
|
+
const attributes = node.attributes ?? [];
|
|
147
|
+
if (!literalAttributes(attributes) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
148
|
+
throw new Error(`${sourceFile}: <${node.name}> needs distinct literal attributes`);
|
|
149
|
+
if (node.name === 'ReaderFilter') {
|
|
150
|
+
if (node.children?.length)
|
|
151
|
+
throw new Error(`${sourceFile}: <ReaderFilter> cannot contain content`);
|
|
152
|
+
const control = validateReaderFilterControl(Object.fromEntries(attributes.map((item) => [item.name, item.value])), readerConfig, `${sourceFile}: <ReaderFilter>`, true);
|
|
153
|
+
return { type: 'docReaderFilter', control };
|
|
154
|
+
}
|
|
155
|
+
const labels = attributes.filter((item) => item.name === 'label');
|
|
156
|
+
if (node.name === 'ReaderSection' && (labels.length || !node.children?.length))
|
|
157
|
+
throw new Error(`${sourceFile}: <ReaderSection> needs content and only configured filter attributes`);
|
|
158
|
+
if (node.name === 'ReaderChoice' && (node.children?.length || labels.length !== 1 || !labels[0].value.trim()))
|
|
159
|
+
throw new Error(`${sourceFile}: <ReaderChoice> needs a label and no child content`);
|
|
160
|
+
const choiceScope = attributes.find((item) => item.name === 'scope')?.value ?? 'site';
|
|
161
|
+
if (node.name === 'ReaderChoice' && !['site', 'page'].includes(choiceScope))
|
|
162
|
+
throw new Error(`${sourceFile}: <ReaderChoice> scope must be site or page`);
|
|
163
|
+
const choices = Object.fromEntries(attributes.filter((item) => item.name !== 'label' && (node.name !== 'ReaderChoice' || item.name !== 'scope')).map((item) => [item.name, item.value.split(',').map((value) => value.trim())]));
|
|
164
|
+
const selection = validateReaderSelection(choices, readerConfig, `${sourceFile}: <${node.name}>`);
|
|
165
|
+
if (!Object.keys(selection).length)
|
|
166
|
+
throw new Error(`${sourceFile}: <${node.name}> needs at least one filter choice`);
|
|
167
|
+
const description = Object.entries(selection).map(([facet, values]) => `${readerConfig.facets[facet].label}: ${values.map(value => readerConfig.facets[facet].options[value]).join(' or ')}`).join('; ');
|
|
168
|
+
const children = node.name === 'ReaderSection' ? childrenOf(node.children ?? [], scope, stack, sourceFile) : [];
|
|
169
|
+
const containsSection = (item) => item.type === 'docReaderSection' || (item.children ?? []).some(containsSection);
|
|
170
|
+
if (children.some(containsSection))
|
|
171
|
+
throw new Error(`${sourceFile}: <ReaderSection> cannot contain another <ReaderSection>`);
|
|
172
|
+
return node.name === 'ReaderSection'
|
|
173
|
+
? { type: 'docReaderSection', selection, description, children }
|
|
174
|
+
: { type: 'docReaderChoice', selection, label: labels[0].value, route: current.route, scope: choiceScope };
|
|
175
|
+
}
|
|
176
|
+
if (node.name === 'Only') {
|
|
177
|
+
if (node.type !== 'mdxJsxFlowElement' || (node.attributes ?? []).length !== 1 || node.attributes?.[0]?.name !== 'format' || !node.children?.length)
|
|
178
|
+
throw new Error(`${sourceFile}: <Only> needs block content and one format attribute`);
|
|
179
|
+
const format = attr(node, 'format');
|
|
180
|
+
if (format !== 'html' && format !== 'markdown')
|
|
181
|
+
throw new Error(`${sourceFile}: <Only> format must be html or markdown`);
|
|
182
|
+
return { type: 'docRepresentation', representation: format, children: childrenOf(node.children, scope, stack, sourceFile) };
|
|
183
|
+
}
|
|
184
|
+
if (node.name === 'Badge') {
|
|
185
|
+
const attributes = node.attributes ?? [];
|
|
186
|
+
if (node.type !== 'mdxJsxTextElement' || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['variant', 'icon'].includes(item.name) || typeof item.value !== 'string') || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
187
|
+
throw new Error(`${sourceFile}: <Badge> needs inline text and literal variant or icon attributes`);
|
|
188
|
+
const variant = attributes.some((item) => item.name === 'variant') ? attr(node, 'variant') : 'neutral';
|
|
189
|
+
if (!badgeVariants.has(variant))
|
|
190
|
+
throw new Error(`${sourceFile}: unknown <Badge> variant "${variant}"; register it in badges.variants`);
|
|
191
|
+
const icon = attributes.some((item) => item.name === 'icon') ? attr(node, 'icon') : undefined;
|
|
192
|
+
if (icon)
|
|
193
|
+
validateLucideIcon(icon, sourceFile, 'Badge icon');
|
|
194
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
195
|
+
if (children.length !== 1 || children[0].type !== 'text' || !String(children[0].value ?? '').trim())
|
|
196
|
+
throw new Error(`${sourceFile}: <Badge> needs plain, nonempty inline text`);
|
|
197
|
+
return { type: 'docBadge', variant, icon, label: children[0].value };
|
|
198
|
+
}
|
|
199
|
+
if (node.name === 'Kbd') {
|
|
200
|
+
if (node.type !== 'mdxJsxTextElement' || node.attributes?.length)
|
|
201
|
+
throw new Error(`${sourceFile}: <Kbd> needs plain inline text without attributes`);
|
|
202
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
203
|
+
if (children.length !== 1 || children[0].type !== 'text' || !String(children[0].value ?? '').trim())
|
|
204
|
+
throw new Error(`${sourceFile}: <Kbd> needs nonempty plain text`);
|
|
205
|
+
return { type: 'docKbd', label: children[0].value };
|
|
206
|
+
}
|
|
207
|
+
if (node.name === 'Tooltip' || node.name === 'InfoHint') {
|
|
208
|
+
const attributes = node.attributes ?? [];
|
|
209
|
+
if (node.name === 'InfoHint' && node.type !== 'mdxJsxFlowElement' || attributes.length !== 1 || attributes[0].type !== 'mdxJsxAttribute' || attributes[0].name !== 'label' || typeof attributes[0].value !== 'string' || !attributes[0].value.trim())
|
|
210
|
+
throw new Error(`${sourceFile}: <${node.name}> needs a literal label${node.name === 'InfoHint' ? ' and a block element' : ''}`);
|
|
211
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
212
|
+
const definition = children.length === 1 && children[0].type === 'paragraph' ? children[0].children ?? [] : children;
|
|
213
|
+
if (definition.length !== 1 || definition[0].type !== 'text' || !String(definition[0].value ?? '').trim())
|
|
214
|
+
throw new Error(`${sourceFile}: <${node.name}> needs one brief plain-text definition`);
|
|
215
|
+
return { type: node.name === 'Tooltip' ? 'docTooltip' : 'docInfoHint', inline: node.type === 'mdxJsxTextElement', label: attributes[0].value.trim(), definition: String(definition[0].value ?? '').trim() };
|
|
216
|
+
}
|
|
217
|
+
if (node.name === 'Progress') {
|
|
218
|
+
const attributes = node.attributes ?? [];
|
|
219
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length || attributes.length !== 3 || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['label', 'value', 'max'].includes(item.name) || typeof item.value !== 'string') || new Set(attributes.map((item) => item.name)).size !== 3)
|
|
220
|
+
throw new Error(`${sourceFile}: <Progress> needs literal label, value, and max attributes with no body`);
|
|
221
|
+
const label = attr(node, 'label').trim();
|
|
222
|
+
const value = Number(attr(node, 'value'));
|
|
223
|
+
const max = Number(attr(node, 'max'));
|
|
224
|
+
if (!label || !Number.isFinite(value) || !Number.isFinite(max) || value < 0 || max <= 0 || value > max)
|
|
225
|
+
throw new Error(`${sourceFile}: <Progress> needs a nonempty label and a value from 0 through positive max`);
|
|
226
|
+
return { type: 'docProgress', label, value, max };
|
|
227
|
+
}
|
|
228
|
+
if (node.name === 'Math') {
|
|
229
|
+
const attributes = node.attributes ?? [];
|
|
230
|
+
if (attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['expression', 'display'].includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length || node.children?.length)
|
|
231
|
+
throw new Error(`${sourceFile}: <Math> needs an expression and no child content`);
|
|
232
|
+
const expression = attr(node, 'expression');
|
|
233
|
+
const display = attributes.find((item) => item.name === 'display');
|
|
234
|
+
if (!expression.trim() || (display && display.value !== null))
|
|
235
|
+
throw new Error(`${sourceFile}: <Math> needs nonempty expression; display is a bare boolean attribute`);
|
|
236
|
+
if (display && node.type !== 'mdxJsxFlowElement')
|
|
237
|
+
throw new Error(`${sourceFile}: display <Math> must be a block`);
|
|
238
|
+
try {
|
|
239
|
+
katex.renderToString(expression, { output: 'mathml', displayMode: !!display, throwOnError: true, strict: 'error', trust: false, maxExpand: 1000 });
|
|
240
|
+
}
|
|
241
|
+
catch (error) {
|
|
242
|
+
throw new Error(`${sourceFile}: invalid <Math> expression: ${error.message}`);
|
|
243
|
+
}
|
|
244
|
+
return { type: 'docMath', expression, display: !!display, block: node.type === 'mdxJsxFlowElement' };
|
|
245
|
+
}
|
|
246
|
+
if (node.name === 'ActionLink' || node.name === 'Button') {
|
|
247
|
+
const attributes = node.attributes ?? [];
|
|
248
|
+
if (attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['href', 'doc', 'variant'].includes(item.name) || typeof item.value !== 'string') || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
249
|
+
throw new Error(`${sourceFile}: <${node.name}> needs literal href or doc and optional variant`);
|
|
250
|
+
if (Number(attributes.some((item) => item.name === 'href')) + Number(attributes.some((item) => item.name === 'doc')) !== 1)
|
|
251
|
+
throw new Error(`${sourceFile}: <${node.name}> needs exactly one href or doc`);
|
|
252
|
+
const variant = attributes.some((item) => item.name === 'variant') ? attr(node, 'variant') : 'primary';
|
|
253
|
+
if (!['primary', 'secondary'].includes(variant))
|
|
254
|
+
throw new Error(`${sourceFile}: <${node.name}> variant must be primary or secondary`);
|
|
255
|
+
const target = attributes.some((item) => item.name === 'doc') ? registry.get(attr(node, 'doc'))?.route : attr(node, 'href');
|
|
256
|
+
if (!target)
|
|
257
|
+
throw new Error(`${sourceFile}: <${node.name}> has an unknown or empty destination`);
|
|
258
|
+
if (!/^(?:\/(?!\/)|#|https?:\/\/|mailto:)/i.test(target))
|
|
259
|
+
throw new Error(`${sourceFile}: <${node.name}> needs a site path, fragment, HTTP(S), or mailto destination`);
|
|
260
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
261
|
+
if (!children.length || children.some((child) => !['text', 'strong', 'emphasis', 'inlineCode'].includes(child.type)))
|
|
262
|
+
throw new Error(`${sourceFile}: <${node.name}> needs nonempty inline text`);
|
|
263
|
+
return { type: 'docActionLink', url: target, variant, children };
|
|
264
|
+
}
|
|
265
|
+
if (node.name === 'DefinitionList') {
|
|
266
|
+
const attributes = node.attributes ?? [];
|
|
267
|
+
if (node.type !== 'mdxJsxFlowElement' || attributes.some((item) => item.type !== 'mdxJsxAttribute' || item.name !== 'filter' || item.value !== null) || attributes.length > 1 || !node.children?.length)
|
|
268
|
+
throw new Error(`${sourceFile}: <DefinitionList> only accepts a bare filter attribute and direct <Term> and <Definition> pairs`);
|
|
269
|
+
const directChildren = node.children.flatMap((child) => child.type === 'paragraph' ? child.children ?? [] : [child]).filter((child) => child.type !== 'text' || String(child.value ?? '').trim());
|
|
270
|
+
const items = [];
|
|
271
|
+
for (let index = 0; index < directChildren.length; index += 2) {
|
|
272
|
+
const term = directChildren[index];
|
|
273
|
+
const definition = directChildren[index + 1];
|
|
274
|
+
if (!term || !definition || term.name !== 'Term' || definition.name !== 'Definition' || term.attributes?.length || definition.attributes?.length)
|
|
275
|
+
throw new Error(`${sourceFile}: <DefinitionList> needs alternating <Term> and <Definition> children without attributes`);
|
|
276
|
+
const termChildren = childrenOf(term.children ?? [], scope, stack, sourceFile);
|
|
277
|
+
const definitionChildren = childrenOf(definition.children ?? [], scope, stack, sourceFile);
|
|
278
|
+
if (!termChildren.length || !definitionChildren.length)
|
|
279
|
+
throw new Error(`${sourceFile}: <Term> and <Definition> need content`);
|
|
280
|
+
items.push({ term: termChildren, definition: definitionChildren });
|
|
281
|
+
}
|
|
282
|
+
return { type: 'docDefinitionList', filter: attributes.length === 1, items };
|
|
283
|
+
}
|
|
284
|
+
if (node.name === 'Term' || node.name === 'Definition')
|
|
285
|
+
throw new Error(`${sourceFile}: <${node.name}> must be directly inside <DefinitionList>`);
|
|
286
|
+
if (node.name === 'Steps' || node.name === 'Timeline')
|
|
287
|
+
return procedureComponent(node, sourceFile, children => childrenOf(children, scope, stack, sourceFile));
|
|
288
|
+
if (node.name === 'Milestone')
|
|
289
|
+
throw new Error(`${sourceFile}: <Milestone> must be directly inside <Timeline>`);
|
|
290
|
+
if (node.name === 'FileTree' || node.name === 'Tree') {
|
|
291
|
+
const controls = node.attributes ?? [];
|
|
292
|
+
if (node.type !== 'mdxJsxFlowElement' || controls.length > 1 || controls.some(a => a.type !== 'mdxJsxAttribute' || a.name !== 'controls' || a.value !== null) || !node.children?.length)
|
|
293
|
+
throw new Error(`${sourceFile}: <${node.name}> accepts a bare controls attribute and direct <Folder> or <File> children`);
|
|
294
|
+
const treeItem = (input) => {
|
|
295
|
+
let item = input;
|
|
296
|
+
if (item.type === 'paragraph' && item.children?.length === 1)
|
|
297
|
+
item = item.children[0];
|
|
298
|
+
if (item.type !== 'mdxJsxFlowElement' || (!item.name || !['Folder', 'File'].includes(item.name)))
|
|
299
|
+
throw new Error(`${sourceFile}: <${node.name}> only accepts <Folder> and <File> nodes`);
|
|
300
|
+
const attributes = item.attributes ?? [];
|
|
301
|
+
if (attributes.some((entry) => entry.type !== 'mdxJsxAttribute' || !['name', 'href', 'doc', 'icon', 'collapsed'].includes(entry.name) || (entry.name === 'collapsed' ? item.name !== 'Folder' || entry.value !== null : typeof entry.value !== 'string')) || new Set(attributes.map((entry) => entry.name)).size !== attributes.length)
|
|
302
|
+
throw new Error(`${sourceFile}: <${item.name}> has an unsupported or duplicate attribute`);
|
|
303
|
+
const name = attr(item, 'name');
|
|
304
|
+
if (!name.trim())
|
|
305
|
+
throw new Error(`${sourceFile}: <${item.name}> needs a nonempty name`);
|
|
306
|
+
if (attributes.some((entry) => entry.name === 'href') && attributes.some((entry) => entry.name === 'doc'))
|
|
307
|
+
throw new Error(`${sourceFile}: <${item.name}> accepts href or doc, not both`);
|
|
308
|
+
const url = attributes.some((entry) => entry.name === 'doc') ? registry.get(attr(item, 'doc'))?.route : attributes.some((entry) => entry.name === 'href') ? attr(item, 'href') : undefined;
|
|
309
|
+
if (attributes.some((entry) => entry.name === 'doc') && !url)
|
|
310
|
+
throw new Error(`${sourceFile}: <${item.name}> has an unknown doc target`);
|
|
311
|
+
if (url && !/^(?:\/(?!\/)|#|https?:\/\/|mailto:)/i.test(url))
|
|
312
|
+
throw new Error(`${sourceFile}: <${item.name}> needs a site path, fragment, HTTP(S), or mailto destination`);
|
|
313
|
+
const icon = attributes.some((entry) => entry.name === 'icon') ? attr(item, 'icon') : undefined;
|
|
314
|
+
if (icon)
|
|
315
|
+
validateLucideIcon(icon, sourceFile, `${item.name} icon`);
|
|
316
|
+
if (item.name === 'File' && item.children?.length)
|
|
317
|
+
throw new Error(`${sourceFile}: <File> cannot have children`);
|
|
318
|
+
const children = item.name === 'Folder' ? (item.children ?? []).map(treeItem) : [];
|
|
319
|
+
return { kind: item.name.toLowerCase(), name, url, icon, children, collapsed: attributes.some(a => a.name === 'collapsed') };
|
|
320
|
+
};
|
|
321
|
+
return { type: 'docFileTree', controls: !!controls.length, items: node.children.map(treeItem) };
|
|
322
|
+
}
|
|
323
|
+
if (node.name === 'Folder' || node.name === 'File')
|
|
324
|
+
throw new Error(`${sourceFile}: <${node.name}> must be inside <FileTree>`);
|
|
325
|
+
if (node.name === 'Table') {
|
|
326
|
+
const attributes = node.attributes ?? [];
|
|
327
|
+
if (node.type !== 'mdxJsxFlowElement' || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['filter', 'sticky'].includes(item.name) || item.value !== null) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
328
|
+
throw new Error(`${sourceFile}: <Table> only accepts bare filter and sticky attributes`);
|
|
329
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
330
|
+
if (children.length !== 1 || children[0].type !== 'table')
|
|
331
|
+
throw new Error(`${sourceFile}: <Table> needs exactly one Markdown table`);
|
|
332
|
+
return { type: 'docTable', filter: attributes.some((item) => item.name === 'filter'), sticky: attributes.some((item) => item.name === 'sticky'), children };
|
|
333
|
+
}
|
|
334
|
+
if (node.name === 'CollapsibleGroup') {
|
|
335
|
+
if (node.type !== 'mdxJsxFlowElement' || node.attributes?.length || !node.children?.length || node.children.some(child => child.type !== 'mdxJsxFlowElement' || child.name !== 'Collapsible'))
|
|
336
|
+
throw new Error(`${sourceFile}: <CollapsibleGroup> needs direct <Collapsible> children and no attributes`);
|
|
337
|
+
return { type: 'docCollapsibleGroup', children: childrenOf(node.children, scope, stack, sourceFile) };
|
|
338
|
+
}
|
|
339
|
+
if (node.name === 'Collapsible') {
|
|
340
|
+
if (node.type !== 'mdxJsxFlowElement' || !node.children?.length)
|
|
341
|
+
throw new Error(`${sourceFile}: <${node.name}> needs block content`);
|
|
342
|
+
const attributes = node.attributes ?? [];
|
|
343
|
+
if (attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['title', 'open'].includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
344
|
+
throw new Error(`${sourceFile}: <${node.name}> only accepts title and open`);
|
|
345
|
+
const title = attr(node, 'title');
|
|
346
|
+
if (!title.trim())
|
|
347
|
+
throw new Error(`${sourceFile}: <${node.name}> title must be nonempty text`);
|
|
348
|
+
const open = attributes.find((item) => item.name === 'open');
|
|
349
|
+
if (open && open.value !== null)
|
|
350
|
+
throw new Error(`${sourceFile}: <${node.name}> open must be a boolean attribute`);
|
|
351
|
+
return { type: 'docCollapsible', title, open: !!open, children: childrenOf(node.children, scope, stack, sourceFile) };
|
|
352
|
+
}
|
|
353
|
+
if (node.name === 'Section') {
|
|
354
|
+
const attributes = node.attributes ?? [];
|
|
355
|
+
if (node.type !== 'mdxJsxFlowElement' || !node.children?.length || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['variant', 'id'].includes(item.name) || typeof item.value !== 'string') || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
356
|
+
throw new Error(`${sourceFile}: <Section> needs block content and only literal variant and id attributes`);
|
|
357
|
+
if (current.frontmatter.layout !== 'splash')
|
|
358
|
+
throw new Error(`${sourceFile}: <Section> needs layout: splash in the page frontmatter`);
|
|
359
|
+
const variant = attributes.some((item) => item.name === 'variant') ? attr(node, 'variant').trim() : undefined;
|
|
360
|
+
if (variant !== undefined && !/^[a-z][a-z0-9-]*$/.test(variant))
|
|
361
|
+
throw new Error(`${sourceFile}: <Section> variant must be lowercase letters, numbers, and dashes`);
|
|
362
|
+
const sectionId = attributes.some((item) => item.name === 'id') ? attr(node, 'id').trim() : undefined;
|
|
363
|
+
if (sectionId !== undefined && !/^[a-z][a-z0-9-]*$/.test(sectionId))
|
|
364
|
+
throw new Error(`${sourceFile}: <Section> id must be lowercase letters, numbers, and dashes`);
|
|
365
|
+
const children = childrenOf(node.children, scope, stack, sourceFile);
|
|
366
|
+
const containsSection = (item) => item.type === 'docSection' || (item.children ?? []).some(containsSection);
|
|
367
|
+
if (children.some(containsSection))
|
|
368
|
+
throw new Error(`${sourceFile}: <Section> cannot contain another <Section>`);
|
|
369
|
+
return { type: 'docSection', variant, sectionId, children };
|
|
370
|
+
}
|
|
371
|
+
if (node.name === 'Hero') {
|
|
372
|
+
const attributes = node.attributes ?? [];
|
|
373
|
+
if (node.type !== 'mdxJsxFlowElement' || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['title', 'tagline', 'align', 'image', 'imageAlt'].includes(item.name) || typeof item.value !== 'string') || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
374
|
+
throw new Error(`${sourceFile}: <Hero> must be a block on its own lines, with only literal title, tagline, align, image, and imageAlt attributes`);
|
|
375
|
+
if (current.frontmatter.layout !== 'landing' && current.frontmatter.layout !== 'splash')
|
|
376
|
+
throw new Error(`${sourceFile}: <Hero> needs layout: landing or splash in the page frontmatter`);
|
|
377
|
+
const tagline = attributes.some((item) => item.name === 'tagline') ? attr(node, 'tagline').trim() : '';
|
|
378
|
+
if (!tagline)
|
|
379
|
+
throw new Error(`${sourceFile}: <Hero> needs a nonempty tagline`);
|
|
380
|
+
const title = attributes.some((item) => item.name === 'title') ? attr(node, 'title').trim() : undefined;
|
|
381
|
+
if (title === '')
|
|
382
|
+
throw new Error(`${sourceFile}: <Hero> title must be nonempty text`);
|
|
383
|
+
const align = attributes.some((item) => item.name === 'align') ? attr(node, 'align') : 'center';
|
|
384
|
+
if (!['center', 'start'].includes(align))
|
|
385
|
+
throw new Error(`${sourceFile}: <Hero> align must be center or start`);
|
|
386
|
+
// Actions are ordinary Markdown links in the body; the first is the primary button. One fenced code block can sit beside the text.
|
|
387
|
+
const links = [];
|
|
388
|
+
const codes = [];
|
|
389
|
+
const collect = (child) => {
|
|
390
|
+
if (child.type === 'link') {
|
|
391
|
+
links.push(child);
|
|
392
|
+
return;
|
|
393
|
+
}
|
|
394
|
+
if (child.type === 'code') {
|
|
395
|
+
codes.push(child);
|
|
396
|
+
return;
|
|
397
|
+
}
|
|
398
|
+
if (child.type === 'text' && !String(child.value ?? '').trim())
|
|
399
|
+
return;
|
|
400
|
+
if (['paragraph', 'list', 'listItem'].includes(child.type))
|
|
401
|
+
return (child.children ?? []).forEach(collect);
|
|
402
|
+
throw new Error(`${sourceFile}: <Hero> body may contain only action links and one code block`);
|
|
403
|
+
};
|
|
404
|
+
childrenOf(node.children ?? [], scope, stack, sourceFile).forEach(collect);
|
|
405
|
+
if (links.length > 3)
|
|
406
|
+
throw new Error(`${sourceFile}: <Hero> accepts at most three action links`);
|
|
407
|
+
if (codes.length > 1)
|
|
408
|
+
throw new Error(`${sourceFile}: <Hero> accepts one code block`);
|
|
409
|
+
const hasImage = attributes.some((item) => item.name === 'image');
|
|
410
|
+
const hasAlt = attributes.some((item) => item.name === 'imageAlt');
|
|
411
|
+
if (hasImage !== hasAlt)
|
|
412
|
+
throw new Error(`${sourceFile}: <Hero> image needs imageAlt, which describes the image or is empty when it is decorative`);
|
|
413
|
+
if (hasImage && codes.length)
|
|
414
|
+
throw new Error(`${sourceFile}: <Hero> can show an image or a code block, not both`);
|
|
415
|
+
let image;
|
|
416
|
+
if (hasImage) {
|
|
417
|
+
const source = attr(node, 'image').trim();
|
|
418
|
+
const alt = attr(node, 'imageAlt').trim();
|
|
419
|
+
if (/^https:\/\//i.test(source))
|
|
420
|
+
image = { url: source, alt };
|
|
421
|
+
else {
|
|
422
|
+
if (/^[a-z][a-z0-9+.-]*:/i.test(source) || !/\.(?:png|jpe?g|webp|svg)$/i.test(source))
|
|
423
|
+
throw new Error(`${sourceFile}: <Hero> image must be an https URL or a local .png, .jpg, .webp, or .svg file`);
|
|
424
|
+
const file = path.resolve(path.dirname(sourceFile), source);
|
|
425
|
+
if (!existsSync(file))
|
|
426
|
+
throw new Error(`${sourceFile}: <Hero> image not found: ${file}`);
|
|
427
|
+
if (!/^[\w.-]+$/.test(path.basename(file)))
|
|
428
|
+
throw new Error(`${sourceFile}: <Hero> image file name may use only letters, numbers, dots, dashes, and underscores`);
|
|
429
|
+
image = { url: `/assets/pages${current.route === '/' ? '/index' : current.route}/${path.basename(file)}`, alt, file };
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
return { type: 'docHero', align, title: title ?? current.frontmatter.title, customTitle: title !== undefined && title !== current.frontmatter.title, tagline, links, image, code: codes[0] };
|
|
433
|
+
}
|
|
434
|
+
if (node.name === 'ThemePreview') {
|
|
435
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length || node.attributes?.length)
|
|
436
|
+
throw new Error(`${sourceFile}: <ThemePreview /> must be an empty block element with no attributes`);
|
|
437
|
+
return { type: 'themePreview' };
|
|
438
|
+
}
|
|
439
|
+
if (node.name === 'Diagram') {
|
|
440
|
+
const attributes = node.attributes ?? [];
|
|
441
|
+
const allowed = ['title', 'summary', 'engine', 'layout', 'width'];
|
|
442
|
+
if (node.type !== 'mdxJsxFlowElement' || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !allowed.includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
443
|
+
throw new Error(`${sourceFile}: <Diagram> needs a block with only title, summary, engine, layout, and width attributes`);
|
|
444
|
+
const title = attr(node, 'title').trim();
|
|
445
|
+
const summary = attr(node, 'summary').trim();
|
|
446
|
+
const engine = attributes.some((item) => item.name === 'engine') ? attr(node, 'engine') : 'd2';
|
|
447
|
+
const layout = attributes.some((item) => item.name === 'layout') ? attr(node, 'layout') : 'tala';
|
|
448
|
+
const width = attributes.some((item) => item.name === 'width') ? attr(node, 'width') : undefined;
|
|
449
|
+
if (width !== undefined && (!/^[1-9]\d{0,3}$/.test(width) || Number(width) > 4096))
|
|
450
|
+
throw new Error(`${sourceFile}: <Diagram> width must be a positive pixel number up to 4096`);
|
|
451
|
+
if (!title || !summary)
|
|
452
|
+
throw new Error(`${sourceFile}: <Diagram> title and summary must be nonempty text`);
|
|
453
|
+
if (!['d2', 'mermaid'].includes(engine))
|
|
454
|
+
throw new Error(`${sourceFile}: <Diagram> engine must be d2 or mermaid`);
|
|
455
|
+
if (engine === 'd2' ? !['tala', 'elk', 'dagre'].includes(layout) : attributes.some((item) => item.name === 'layout'))
|
|
456
|
+
throw new Error(`${sourceFile}: <Diagram> layout must be tala, elk, or dagre and is only available for D2`);
|
|
457
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
458
|
+
if (children.length !== 1 || children[0].type !== 'code' || children[0].lang !== engine || !String(children[0].value ?? '').trim())
|
|
459
|
+
throw new Error(`${sourceFile}: <Diagram> needs exactly one nonempty ${engine} code fence`);
|
|
460
|
+
return { type: 'docDiagram', title, summary, engine, layout, width: width ? Number(width) : undefined, source: children[0].value, file: sourceFile };
|
|
461
|
+
}
|
|
462
|
+
if (node.name === 'Image') {
|
|
463
|
+
const attributes = node.attributes ?? [];
|
|
464
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length || attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['src', 'alt', 'width', 'align', 'caption', 'expand'].includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
465
|
+
throw new Error(`${sourceFile}: <Image> must be an empty block with literal src, alt, optional width/align/caption, and a bare expand attribute`);
|
|
466
|
+
if (!attributes.some(a => a.name === 'src' && typeof a.value === 'string') || !attributes.some(a => a.name === 'alt' && typeof a.value === 'string') || attributes.some(a => a.name === 'expand' ? a.value !== null : typeof a.value !== 'string'))
|
|
467
|
+
throw new Error(`${sourceFile}: <Image> needs literal src/alt, optional width/align/caption, and a bare expand attribute`);
|
|
468
|
+
const source = attr(node, 'src').trim();
|
|
469
|
+
const alt = attr(node, 'alt').trim();
|
|
470
|
+
const width = attributes.some(a => a.name === 'width') ? attr(node, 'width') : undefined;
|
|
471
|
+
if (attributes.some(a => a.name === 'width') && (!/^[1-9]\d{0,3}$/.test(width ?? '') || Number(width) > 4096))
|
|
472
|
+
throw new Error(`${sourceFile}: <Image> width must be a positive pixel number up to 4096`);
|
|
473
|
+
let image;
|
|
474
|
+
if (/^https:\/\//i.test(source))
|
|
475
|
+
image = { url: source };
|
|
476
|
+
else {
|
|
477
|
+
if (/^[a-z][a-z0-9+.-]*:/i.test(source) || source.startsWith('/') || !/\.(?:png|jpe?g|webp|svg)$/i.test(source))
|
|
478
|
+
throw new Error(`${sourceFile}: <Image> src must be an https URL or a local .png, .jpg, .webp, or .svg file`);
|
|
479
|
+
const file = path.resolve(path.dirname(sourceFile), source);
|
|
480
|
+
if (!existsSync(file))
|
|
481
|
+
throw new Error(`${sourceFile}: <Image> file not found: ${file}`);
|
|
482
|
+
if (!/^[\w.-]+$/.test(path.basename(file)))
|
|
483
|
+
throw new Error(`${sourceFile}: <Image> file name may use only letters, numbers, dots, dashes, and underscores`);
|
|
484
|
+
image = { url: `/assets/pages${current.route === '/' ? '/index' : current.route}/${path.basename(file)}`, file };
|
|
485
|
+
}
|
|
486
|
+
const align = attributes.some(a => a.name === 'align') ? attr(node, 'align') : undefined;
|
|
487
|
+
if (attributes.some(a => a.name === 'align') && !['left', 'center', 'right'].includes(align ?? ''))
|
|
488
|
+
throw new Error(`${sourceFile}: <Image> align must be left, center, or right`);
|
|
489
|
+
return { type: 'docImage', ...image, alt, align, width: width ? Number(width) : undefined, caption: attributes.some(a => a.name === 'caption') ? attr(node, 'caption') : undefined, expand: attributes.some(a => a.name === 'expand') };
|
|
490
|
+
}
|
|
491
|
+
if (node.name === 'Tabs') {
|
|
492
|
+
const tabsAttributes = node.attributes ?? [];
|
|
493
|
+
if (node.type !== 'mdxJsxFlowElement' || tabsAttributes.some((item) => item.type !== 'mdxJsxAttribute' || !['label', 'equalHeight', 'sync'].includes(item.name)) || new Set(tabsAttributes.map((item) => item.name)).size !== tabsAttributes.length || !tabsAttributes.some((item) => item.name === 'label'))
|
|
494
|
+
throw new Error(`${sourceFile}: <Tabs> needs a literal label`);
|
|
495
|
+
const equalHeight = tabsAttributes.find((item) => item.name === 'equalHeight');
|
|
496
|
+
if (equalHeight && equalHeight.value !== null)
|
|
497
|
+
throw new Error(`${sourceFile}: <Tabs> equalHeight must be a boolean attribute`);
|
|
498
|
+
const sync = tabsAttributes.some(a => a.name === 'sync') ? attr(node, 'sync') : undefined;
|
|
499
|
+
if (sync !== undefined && !/^[a-zA-Z0-9][a-zA-Z0-9_-]{0,63}$/.test(sync))
|
|
500
|
+
throw new Error(`${sourceFile}: <Tabs> sync needs a group name using letters, numbers, dashes, or underscores (up to 64 characters)`);
|
|
501
|
+
const label = attr(node, 'label');
|
|
502
|
+
if (!label.trim() || (node.children?.length ?? 0) < 2)
|
|
503
|
+
throw new Error(`${sourceFile}: <Tabs> needs a label and at least two tabs`);
|
|
504
|
+
const id = `tabs-${createHash('sha256').update(`${current.frontmatter.id}|${++tabsIndex}`).digest('hex').slice(0, 10)}`;
|
|
505
|
+
const children = (node.children ?? []).map((tab) => {
|
|
506
|
+
if (tab.type !== 'mdxJsxFlowElement' || tab.name !== 'Tab' || (tab.attributes ?? []).some(a => a.type !== 'mdxJsxAttribute' || !['label', 'value'].includes(a.name) || typeof a.value !== 'string') || new Set((tab.attributes ?? []).map(a => a.name)).size !== (tab.attributes ?? []).length || !tab.children?.length)
|
|
507
|
+
throw new Error(`${sourceFile}: <Tabs> only accepts nonempty <Tab label="..."> children`);
|
|
508
|
+
const tabLabel = attr(tab, 'label');
|
|
509
|
+
if (!tabLabel.trim())
|
|
510
|
+
throw new Error(`${sourceFile}: <Tab> label must be nonempty text`);
|
|
511
|
+
const value = (tab.attributes ?? []).some(a => a.name === 'value') ? attr(tab, 'value') : tabLabel;
|
|
512
|
+
if (!value.trim())
|
|
513
|
+
throw new Error(`${sourceFile}: <Tab> value must be nonempty text`);
|
|
514
|
+
return { type: 'docTab', label: tabLabel, value, children: childrenOf(tab.children, scope, stack, sourceFile) };
|
|
515
|
+
});
|
|
516
|
+
if (new Set(children.map(tab => tab.value)).size !== children.length)
|
|
517
|
+
throw new Error(`${sourceFile}: <Tabs> needs unique tab values (labels by default)`);
|
|
518
|
+
return { type: 'docTabs', label, id, sync, equalHeight: !!equalHeight, children };
|
|
519
|
+
}
|
|
520
|
+
if (node.name === 'Walkthrough')
|
|
521
|
+
return walkthroughComponent(node, sourceFile, current.frontmatter.id, ++walkthroughIndex, children => childrenOf(children, scope, stack, sourceFile), projectRoot);
|
|
522
|
+
if (node.name === 'Step')
|
|
523
|
+
throw new Error(`${sourceFile}: <Step> must be directly inside <Steps> or <Walkthrough>`);
|
|
524
|
+
if (node.name === 'Tab')
|
|
525
|
+
throw new Error(`${sourceFile}: <Tab> must be directly inside <Tabs>`);
|
|
526
|
+
if (node.name === 'Fields') {
|
|
527
|
+
if (node.type !== 'mdxJsxFlowElement' || (node.attributes ?? []).length || !node.children?.length)
|
|
528
|
+
throw new Error(`${sourceFile}: <Fields> needs direct <Field> children and no attributes`);
|
|
529
|
+
const items = node.children.map((child) => {
|
|
530
|
+
const field = child.type === 'paragraph' && child.children?.length === 1 && child.children[0].name === 'Field' ? child.children[0] : child;
|
|
531
|
+
if (!['mdxJsxFlowElement', 'mdxJsxTextElement'].includes(field.type) || field.name !== 'Field')
|
|
532
|
+
throw new Error(`${sourceFile}: <Fields> only accepts direct <Field> children`);
|
|
533
|
+
const attributes = field.attributes ?? [];
|
|
534
|
+
const allowed = ['name', 'type', 'required', 'optional', 'nullable', 'deprecated', 'min', 'max', 'minimum', 'maximum', 'minLength', 'maxLength', 'minItems', 'maxItems', 'format', 'pattern', 'example', 'default'];
|
|
535
|
+
if (attributes.some((item) => item.type !== 'mdxJsxAttribute' || !allowed.includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
536
|
+
throw new Error(`${sourceFile}: <Field> has an unknown or duplicate attribute`);
|
|
537
|
+
const name = attr(field, 'name').trim();
|
|
538
|
+
const fieldType = attr(field, 'type').trim();
|
|
539
|
+
if (!name || !fieldType)
|
|
540
|
+
throw new Error(`${sourceFile}: <Field> name and type must be nonempty text`);
|
|
541
|
+
const boolean = (key) => {
|
|
542
|
+
const item = attributes.find((entry) => entry.name === key);
|
|
543
|
+
if (item && item.value !== null)
|
|
544
|
+
throw new Error(`${sourceFile}: <Field> ${key} must be a boolean attribute`);
|
|
545
|
+
return !!item;
|
|
546
|
+
};
|
|
547
|
+
const required = boolean('required');
|
|
548
|
+
const optional = boolean('optional');
|
|
549
|
+
const nullable = boolean('nullable');
|
|
550
|
+
const deprecated = boolean('deprecated');
|
|
551
|
+
if (required && optional)
|
|
552
|
+
throw new Error(`${sourceFile}: <Field> cannot be both required and optional`);
|
|
553
|
+
if (attributes.some((item) => item.name === 'min') && attributes.some((item) => item.name === 'minimum') || attributes.some((item) => item.name === 'max') && attributes.some((item) => item.name === 'maximum'))
|
|
554
|
+
throw new Error(`${sourceFile}: <Field> cannot combine min with minimum or max with maximum`);
|
|
555
|
+
const numeric = (key, integer) => {
|
|
556
|
+
if (!attributes.some((item) => item.name === key))
|
|
557
|
+
return undefined;
|
|
558
|
+
const raw = attr(field, key);
|
|
559
|
+
const value = Number(raw);
|
|
560
|
+
if (!raw.trim() || !Number.isFinite(value) || (integer && (!Number.isInteger(value) || value < 0)))
|
|
561
|
+
throw new Error(`${sourceFile}: <Field> ${key} must be ${integer ? 'a nonnegative integer' : 'a finite number'}`);
|
|
562
|
+
return value;
|
|
563
|
+
};
|
|
564
|
+
const minimum = numeric(attributes.some((item) => item.name === 'min') ? 'min' : 'minimum', false);
|
|
565
|
+
const maximum = numeric(attributes.some((item) => item.name === 'max') ? 'max' : 'maximum', false);
|
|
566
|
+
const minLength = numeric('minLength', true);
|
|
567
|
+
const maxLength = numeric('maxLength', true);
|
|
568
|
+
const minItems = numeric('minItems', true);
|
|
569
|
+
const maxItems = numeric('maxItems', true);
|
|
570
|
+
for (const [low, high, label] of [[minimum, maximum, 'min/max'], [minLength, maxLength, 'minLength/maxLength'], [minItems, maxItems, 'minItems/maxItems']])
|
|
571
|
+
if (low !== undefined && high !== undefined && low > high)
|
|
572
|
+
throw new Error(`${sourceFile}: <Field> ${label} range is reversed`);
|
|
573
|
+
const details = [fieldType, ...(nullable ? ['nullable'] : []), ...(deprecated ? ['deprecated'] : []), ...(minimum !== undefined ? [`minimum: ${minimum}`] : []), ...(maximum !== undefined ? [`maximum: ${maximum}`] : []), ...(minLength !== undefined ? [`minLength: ${minLength}`] : []), ...(maxLength !== undefined ? [`maxLength: ${maxLength}`] : []), ...(minItems !== undefined ? [`minItems: ${minItems}`] : []), ...(maxItems !== undefined ? [`maxItems: ${maxItems}`] : []), ...['format', 'pattern'].filter(key => attributes.some((item) => item.name === key)).map(key => {
|
|
574
|
+
const value = attr(field, key).trim();
|
|
575
|
+
if (!value)
|
|
576
|
+
throw new Error(`${sourceFile}: <Field> ${key} must be nonempty text`);
|
|
577
|
+
return `${key}: ${value}`;
|
|
578
|
+
})];
|
|
579
|
+
const title = paragraph({ type: 'inlineCode', value: name }, text(' — '), { type: 'strong', children: [text(required ? 'required' : 'optional')] });
|
|
580
|
+
const examples = ['example', 'default'].filter(key => attributes.some((item) => item.name === key)).map(key => paragraph(text(`${key === 'example' ? 'Example' : 'Default'}: `), { type: 'inlineCode', value: attr(field, key) }));
|
|
581
|
+
const body = childrenOf(field.children ?? [], scope, stack, sourceFile);
|
|
582
|
+
return { type: 'listItem', spread: true, data: { hProperties: { 'data-field': '', 'data-presence': required ? 'present' : 'optional' } }, children: [title, paragraph(text(details.join('; '))), ...examples, ...(field.type === 'mdxJsxTextElement' ? [paragraph(...body)] : body)] };
|
|
583
|
+
});
|
|
584
|
+
return { type: 'list', ordered: false, children: items };
|
|
585
|
+
}
|
|
586
|
+
if (node.name === 'Field')
|
|
587
|
+
throw new Error(`${sourceFile}: <Field> must be directly inside <Fields>`);
|
|
588
|
+
if (node.name === 'CookbookChooser')
|
|
589
|
+
return cookbookChooserComponent(node, sourceFile);
|
|
590
|
+
if (node.name && ['DocCard', 'DocCards', 'DocCollection', 'RelatedReading'].includes(node.name))
|
|
591
|
+
return cardComponent(node, sourceFile);
|
|
592
|
+
if (node.name && ['ApiExample', 'ApiSchema'].includes(node.name)) {
|
|
593
|
+
if (stack.length)
|
|
594
|
+
throw new Error(`${sourceFile}: API includes need page-level headings; place them in the page`);
|
|
595
|
+
return apiEmbedComponent(node, sourceFile);
|
|
596
|
+
}
|
|
597
|
+
if (node.name === 'Snippet') {
|
|
598
|
+
if (node.type !== 'mdxJsxFlowElement' || node.children?.length)
|
|
599
|
+
throw new Error(`${sourceFile}: <Snippet> must be a standalone empty element`);
|
|
600
|
+
const id = attr(node, 'id');
|
|
601
|
+
const definition = snippets.get(id);
|
|
602
|
+
if (!definition)
|
|
603
|
+
throw new Error(`${sourceFile}: unknown snippet ${id}`);
|
|
604
|
+
if (stack.includes(id))
|
|
605
|
+
throw new Error(`${sourceFile}: recursive snippet include ${[...stack, id].join(' -> ')}`);
|
|
606
|
+
const settings = node.attributes ?? [];
|
|
607
|
+
if (settings.some((item) => item.type !== 'mdxJsxAttribute' || !['id', 'values'].includes(item.name)))
|
|
608
|
+
throw new Error(`${sourceFile}: <Snippet> only accepts id and values`);
|
|
609
|
+
if (new Set(settings.map((item) => item.name)).size !== settings.length)
|
|
610
|
+
throw new Error(`${sourceFile}: <Snippet> has duplicate attributes`);
|
|
611
|
+
const valuesAttribute = settings.find((item) => item.name === 'values');
|
|
612
|
+
const invocation = valuesAttribute ? snippetAttribute(valuesAttribute, `${sourceFile}: <Snippet>`) : {};
|
|
613
|
+
if (!invocation || typeof invocation !== 'object' || Array.isArray(invocation))
|
|
614
|
+
throw new Error(`${sourceFile}: snippet values must be a literal mapping`);
|
|
615
|
+
const values = resolveSnippetValues(id, definition, projectValues, { ...(current.frontmatter.variables ?? {}), ...scope }, invocation);
|
|
616
|
+
uses.push({ id, file: definition.file, documentId: current.frontmatter.id });
|
|
617
|
+
return childrenOf(definition.tree.children, values, [...stack, id], definition.file);
|
|
618
|
+
}
|
|
619
|
+
if (node.name === 'Var') {
|
|
620
|
+
if (!stack.length || node.type !== 'mdxJsxTextElement' || node.children?.length)
|
|
621
|
+
throw new Error(`${sourceFile}: <Var> must be an inline snippet variable`);
|
|
622
|
+
const name = attr(node, 'name');
|
|
623
|
+
if (node.attributes?.length !== 1 || !Object.prototype.hasOwnProperty.call(scope, name))
|
|
624
|
+
throw new Error(`${sourceFile}: unresolved snippet variable ${name}`);
|
|
625
|
+
return text(String(scope[name]));
|
|
626
|
+
}
|
|
627
|
+
if (node.name === 'DocLink') {
|
|
628
|
+
const target = registry.get(attr(node, 'doc'));
|
|
629
|
+
if (!target)
|
|
630
|
+
throw new Error(`${sourceFile}: unknown DocLink target`);
|
|
631
|
+
return link(target.route, (node.children ?? []).map((x) => x.value ?? '').join('') || target.frontmatter.title);
|
|
632
|
+
}
|
|
633
|
+
if (node.name === 'Callout') {
|
|
634
|
+
const attributes = node.attributes ?? [];
|
|
635
|
+
if (attributes.some((item) => item.type !== 'mdxJsxAttribute' || !['type', 'label'].includes(item.name)) || new Set(attributes.map((item) => item.name)).size !== attributes.length)
|
|
636
|
+
throw new Error(`${sourceFile}: <Callout> only accepts type and label`);
|
|
637
|
+
const hasLabel = attributes.some((item) => item.name === 'label');
|
|
638
|
+
const type = attributes.some((item) => item.name === 'type') ? attr(node, 'type') : hasLabel ? undefined : 'note';
|
|
639
|
+
const definition = type === undefined ? undefined : calloutTypes.get(type);
|
|
640
|
+
if (type !== undefined && !definition)
|
|
641
|
+
throw new Error(`${sourceFile}: unknown <Callout> type "${type}"; register it in callouts.types`);
|
|
642
|
+
const label = hasLabel ? attr(node, 'label').trim() : definition.label;
|
|
643
|
+
if (!label)
|
|
644
|
+
throw new Error(`${sourceFile}: <Callout> label must be nonempty text`);
|
|
645
|
+
const children = childrenOf(node.children ?? [], scope, stack, sourceFile);
|
|
646
|
+
const inlineTypes = new Set(['text', 'inlineCode', 'strong', 'emphasis', 'delete', 'link', 'image', 'break']);
|
|
647
|
+
let first;
|
|
648
|
+
if (children[0]?.type === 'paragraph')
|
|
649
|
+
first = children.shift();
|
|
650
|
+
else {
|
|
651
|
+
const blockIndex = children.findIndex((child) => !inlineTypes.has(child.type));
|
|
652
|
+
first = paragraph(...children.splice(0, blockIndex < 0 ? children.length : blockIndex));
|
|
653
|
+
}
|
|
654
|
+
first.children = [...(definition?.icon ? [calloutIcon(definition.icon)] : []), { type: 'strong', children: [text(`${label}:`)] }, text(' '), ...(first.children ?? [])];
|
|
655
|
+
const colors = definition?.colors;
|
|
656
|
+
return { type: 'blockquote', data: { hProperties: { className: ['callout', `callout-${definition?.tone ?? 'neutral'}`], ...(type ? { 'data-callout-type': type } : {}), ...(colors ? { style: `--callout-line:${colors.line};--callout-bg:${colors.background};--callout-text:${colors.text}${colors.dark ? `;--callout-dark-line:${colors.dark.line};--callout-dark-bg:${colors.dark.background};--callout-dark-text:${colors.dark.text}` : ''}` } : {}), ...(colors?.dark ? { 'data-callout-dark': '' } : {}) } }, children: [first, ...children] };
|
|
657
|
+
}
|
|
658
|
+
throw new Error(`${sourceFile}: <${node.name}> has no semantic/Markdown adapter`);
|
|
659
|
+
}
|
|
660
|
+
if (['link', 'definition'].includes(node.type) && typeof node.url === 'string' && node.url.startsWith('doc:')) {
|
|
661
|
+
const target = registry.get(node.url.slice(4));
|
|
662
|
+
if (!target)
|
|
663
|
+
throw new Error(`${sourceFile}: unknown document link ${node.url}`);
|
|
664
|
+
return { ...node, url: target.route, exportDocumentId: target.frontmatter.id, children: childrenOf(node.children ?? [], scope, stack, sourceFile) };
|
|
665
|
+
}
|
|
666
|
+
const markdownImage = node.type === 'image' || (node.type === 'definition' && typeof node.identifier === 'string' && imageReferences.get(sourceFile)?.has(node.identifier));
|
|
667
|
+
if (stack.length && (node.type === 'link' || markdownImage) && typeof node.url === 'string' && !/^(?:\/|#|[a-z][a-z0-9+.-]*:)/i.test(node.url))
|
|
668
|
+
throw new Error(`${sourceFile}: snippet links and assets need absolute or doc: URLs`);
|
|
669
|
+
if (markdownImage && typeof node.url === 'string' && !/^(?:\/|#|[a-z][a-z0-9+.-]*:)/i.test(node.url)) {
|
|
670
|
+
const [, pathname, suffix = ''] = /^([^?#]*)([?#].*)?$/.exec(node.url);
|
|
671
|
+
let localPath;
|
|
672
|
+
try {
|
|
673
|
+
localPath = decodeURIComponent(pathname);
|
|
674
|
+
}
|
|
675
|
+
catch {
|
|
676
|
+
throw new Error(`${sourceFile}: invalid local image URL ${node.url}`);
|
|
677
|
+
}
|
|
678
|
+
if (!/\.(?:png|jpe?g|webp|svg|gif|avif)$/i.test(localPath))
|
|
679
|
+
throw new Error(`${sourceFile}: local Markdown image must be a .png, .jpg, .jpeg, .webp, .svg, .gif, or .avif file`);
|
|
680
|
+
const file = path.resolve(path.dirname(sourceFile), localPath);
|
|
681
|
+
if (!existsSync(file))
|
|
682
|
+
throw new Error(`${sourceFile}: image not found: ${file}`);
|
|
683
|
+
const extension = path.extname(file);
|
|
684
|
+
const stem = path.basename(file, extension).replace(/[^A-Za-z0-9._-]/g, '-');
|
|
685
|
+
const identity = createHash('sha256').update(path.relative(path.dirname(sourceFile), file).split(path.sep).join('/')).digest('hex').slice(0, 12);
|
|
686
|
+
return { ...node, url: `/assets/pages${current.route === '/' ? '/index' : current.route}/${stem}-${identity}${extension}${suffix}`, file };
|
|
687
|
+
}
|
|
688
|
+
if (node.children) {
|
|
689
|
+
const children = childrenOf(node.children, scope, stack, sourceFile);
|
|
690
|
+
if (node.type === 'paragraph' && children.length === 1 && children[0].type === 'blockquote')
|
|
691
|
+
return children[0];
|
|
692
|
+
return { ...node, children };
|
|
693
|
+
}
|
|
694
|
+
return node;
|
|
695
|
+
}
|
|
696
|
+
return walk(tree, {}, [], current.file);
|
|
697
|
+
}
|