@vercel/geistdocs 1.28.0 → 2.0.0
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/dist/assets/geistcn/__internal__/components/icon/base-icon.d.ts +59 -0
- package/dist/assets/geistcn/__internal__/components/icon/base-icon.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/components/icon/base-icon.js +32 -0
- package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.d.ts +65 -0
- package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/components/logo/base-logo-svg.js +41 -0
- package/dist/assets/geistcn/__internal__/types/color.d.ts +12 -0
- package/dist/assets/geistcn/__internal__/types/color.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/types/color.js +25 -0
- package/dist/assets/geistcn/__internal__/types/icon.d.ts +6 -0
- package/dist/assets/geistcn/__internal__/types/icon.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/types/icon.js +1 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.d.ts +16 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-icon-dimensions.js +15 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.d.ts +30 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/utils/calculate-logo-dimensions.js +30 -0
- package/dist/assets/geistcn/__internal__/utils/parse-icon-size.d.ts +8 -0
- package/dist/assets/geistcn/__internal__/utils/parse-icon-size.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/utils/parse-icon-size.js +13 -0
- package/dist/assets/geistcn/__internal__/utils/svg-color.d.ts +13 -0
- package/dist/assets/geistcn/__internal__/utils/svg-color.d.ts.map +1 -0
- package/dist/assets/geistcn/__internal__/utils/svg-color.js +10 -0
- package/dist/assets/geistcn/icons/named/icon-acronym-markdown.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-acronym-markdown.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-acronym-markdown.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-archive.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-archive.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-archive.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-circle-up.js +26 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-down.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-down.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-down.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up-right-small.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-arrow-up.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-bookmark.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-bookmark.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-bookmark.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-box.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-box.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-box.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-check.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-check.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-check.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-double-right.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-double-right.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-double-right.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down-small.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down-small.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down-small.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-down.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-left.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-left.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-left.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right-small.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right-small.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right-small.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-right.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up-down.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up-down.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up-down.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-chevron-up.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-circle.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-circle.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-circle.js +26 -0
- package/dist/assets/geistcn/icons/named/icon-copy.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-copy.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-copy.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-credit-card.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-credit-card.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-credit-card.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-cross.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-cross.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-cross.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-device-desktop.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-device-desktop.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-device-desktop.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-external.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-external.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-external.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-file-text.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-file-text.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-file-text.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-file.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-file.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-file.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-fluid.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-fluid.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-fluid.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-information.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-information.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-information.js +26 -0
- package/dist/assets/geistcn/icons/named/icon-languages.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-languages.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-languages.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-link.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-link.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-link.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-menu-alt.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-menu-alt.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-menu-alt.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-message.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-message.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-message.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-moon.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-moon.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-moon.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-rss.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-rss.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-rss.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-slash-forward.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-slash-forward.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-slash-forward.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-stop-circle.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-stop-circle.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-stop-circle.js +26 -0
- package/dist/assets/geistcn/icons/named/icon-sun.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-sun.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-sun.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-terminal.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-terminal.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-terminal.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-thumb-up.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-thumb-up.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-thumb-up.js +25 -0
- package/dist/assets/geistcn/icons/named/icon-trash.d.ts +26 -0
- package/dist/assets/geistcn/icons/named/icon-trash.d.ts.map +1 -0
- package/dist/assets/geistcn/icons/named/icon-trash.js +25 -0
- package/dist/assets/geistcn/logos/named/logo-eve-svg.d.ts +35 -0
- package/dist/assets/geistcn/logos/named/logo-eve-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-eve-svg.js +37 -0
- package/dist/assets/geistcn/logos/named/logo-icon-github-svg.d.ts +27 -0
- package/dist/assets/geistcn/logos/named/logo-icon-github-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-icon-github-svg.js +27 -0
- package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.d.ts +27 -0
- package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-icon-v0-svg.js +26 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.d.ts +27 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-fill-svg.js +26 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.d.ts +27 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-icon-vercel-svg.js +26 -0
- package/dist/assets/geistcn/logos/named/logo-next-js-svg.d.ts +35 -0
- package/dist/assets/geistcn/logos/named/logo-next-js-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-next-js-svg.js +37 -0
- package/dist/assets/geistcn/logos/named/logo-svelte-svg.d.ts +35 -0
- package/dist/assets/geistcn/logos/named/logo-svelte-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-svelte-svg.js +37 -0
- package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.d.ts +35 -0
- package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.d.ts.map +1 -0
- package/dist/assets/geistcn/logos/named/logo-vercel-oss-svg.js +37 -0
- package/dist/assets/icons/index.d.ts +1 -4
- package/dist/assets/icons/index.d.ts.map +1 -1
- package/dist/assets/icons/index.js +1 -4
- package/dist/assets/logos/index.d.ts +1 -4
- package/dist/assets/logos/index.d.ts.map +1 -1
- package/dist/assets/logos/index.js +1 -4
- package/dist/cli/index.js +5 -5
- package/dist/components/blockquote.d.ts +3 -0
- package/dist/components/blockquote.d.ts.map +1 -0
- package/dist/components/blockquote.js +3 -0
- package/dist/components/callout.d.ts +13 -10
- package/dist/components/callout.d.ts.map +1 -1
- package/dist/components/callout.js +7 -7
- package/dist/components/code-block-tabs.d.ts +5 -2
- package/dist/components/code-block-tabs.d.ts.map +1 -1
- package/dist/components/code-block-tabs.js +30 -5
- package/dist/components/code-block.d.ts +2 -6
- package/dist/components/code-block.d.ts.map +1 -1
- package/dist/components/code-block.js +22 -68
- package/dist/components/command-prompt.d.ts.map +1 -1
- package/dist/components/command-prompt.js +18 -25
- package/dist/components/copy-prompt.d.ts +2 -1
- package/dist/components/copy-prompt.d.ts.map +1 -1
- package/dist/components/copy-prompt.js +5 -5
- package/dist/components/heading.d.ts +7 -0
- package/dist/components/heading.d.ts.map +1 -0
- package/dist/components/heading.js +14 -0
- package/dist/components/image.d.ts +19 -0
- package/dist/components/image.d.ts.map +1 -0
- package/dist/components/image.js +9 -0
- package/dist/components/mermaid.js +1 -1
- package/dist/components/steps.d.ts +9 -0
- package/dist/components/steps.d.ts.map +1 -0
- package/dist/components/steps.js +9 -0
- package/dist/components/table.d.ts +3 -0
- package/dist/components/table.d.ts.map +1 -0
- package/dist/components/table.js +3 -0
- package/dist/controls.d.ts +8 -4
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +16 -15
- package/dist/footer.d.ts.map +1 -1
- package/dist/footer.js +6 -6
- package/dist/internal/changelog-entries.d.ts.map +1 -1
- package/dist/internal/changelog-entries.js +3 -3
- package/dist/internal/chat/activity.d.ts +20 -0
- package/dist/internal/chat/activity.d.ts.map +1 -0
- package/dist/internal/chat/activity.js +43 -0
- package/dist/internal/chat/context.d.ts +2 -0
- package/dist/internal/chat/context.d.ts.map +1 -1
- package/dist/internal/chat/context.js +24 -3
- package/dist/internal/chat/conversation.d.ts +4 -3
- package/dist/internal/chat/conversation.d.ts.map +1 -1
- package/dist/internal/chat/conversation.js +5 -5
- package/dist/internal/chat/copy-chat.d.ts.map +1 -1
- package/dist/internal/chat/copy-chat.js +13 -10
- package/dist/internal/chat/dots-spinner.d.ts +5 -0
- package/dist/internal/chat/dots-spinner.d.ts.map +1 -0
- package/dist/internal/chat/dots-spinner.js +21 -0
- package/dist/internal/chat/loading-skeleton.d.ts +7 -0
- package/dist/internal/chat/loading-skeleton.d.ts.map +1 -0
- package/dist/internal/chat/loading-skeleton.js +46 -0
- package/dist/internal/chat/message-metadata.d.ts.map +1 -1
- package/dist/internal/chat/message-metadata.js +18 -32
- package/dist/internal/chat/message-sources.d.ts +3 -0
- package/dist/internal/chat/message-sources.d.ts.map +1 -0
- package/dist/internal/chat/message-sources.js +23 -0
- package/dist/internal/chat/message.d.ts.map +1 -1
- package/dist/internal/chat/message.js +62 -8
- package/dist/internal/chat/prompt-input.d.ts +1 -1
- package/dist/internal/chat/prompt-input.d.ts.map +1 -1
- package/dist/internal/chat/prompt-input.js +25 -27
- package/dist/internal/chat/shell.d.ts.map +1 -1
- package/dist/internal/chat/shell.js +43 -46
- package/dist/internal/chat/source-chunks.d.ts +9 -0
- package/dist/internal/chat/source-chunks.d.ts.map +1 -0
- package/dist/internal/chat/source-chunks.js +7 -0
- package/dist/internal/chat/sources.d.ts +4 -2
- package/dist/internal/chat/sources.d.ts.map +1 -1
- package/dist/internal/chat/sources.js +12 -6
- package/dist/internal/chat/suggestion.d.ts +11 -6
- package/dist/internal/chat/suggestion.d.ts.map +1 -1
- package/dist/internal/chat/suggestion.js +5 -5
- package/dist/internal/docs-page-error-boundary.js +3 -3
- package/dist/internal/external-arrow.js +1 -1
- package/dist/internal/footer/rss-button.d.ts.map +1 -1
- package/dist/internal/footer/rss-button.js +3 -3
- package/dist/internal/github-button.d.ts.map +1 -1
- package/dist/internal/github-button.js +3 -3
- package/dist/internal/link-href.d.ts +13 -0
- package/dist/internal/link-href.d.ts.map +1 -0
- package/dist/internal/link-href.js +51 -0
- package/dist/internal/markdown-negotiation.d.ts +2 -0
- package/dist/internal/markdown-negotiation.d.ts.map +1 -0
- package/dist/internal/markdown-negotiation.js +3 -0
- package/dist/internal/mdx-to-markdown.d.ts +3 -0
- package/dist/internal/mdx-to-markdown.d.ts.map +1 -0
- package/dist/internal/mdx-to-markdown.js +166 -0
- package/dist/internal/mousedown-navigation-utils.d.ts +5 -0
- package/dist/internal/mousedown-navigation-utils.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation-utils.js +95 -0
- package/dist/internal/mousedown-navigation.d.ts +10 -0
- package/dist/internal/mousedown-navigation.d.ts.map +1 -0
- package/dist/internal/mousedown-navigation.js +42 -0
- package/dist/internal/navbar/desktop-menu.d.ts.map +1 -1
- package/dist/internal/navbar/desktop-menu.js +3 -3
- package/dist/internal/navbar/mobile-menu.d.ts.map +1 -1
- package/dist/internal/navbar/mobile-menu.js +11 -16
- package/dist/internal/navbar/navbar-logo.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-logo.js +5 -7
- package/dist/internal/navbar/navbar-shell.d.ts.map +1 -1
- package/dist/internal/navbar/navbar-shell.js +3 -2
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +51 -30
- package/dist/internal/page-breadcrumb.js +3 -3
- package/dist/internal/page-footer.js +2 -2
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +36 -12
- package/dist/internal/react-node-text.d.ts +4 -0
- package/dist/internal/react-node-text.d.ts.map +1 -0
- package/dist/internal/react-node-text.js +11 -0
- package/dist/internal/search.d.ts.map +1 -1
- package/dist/internal/search.js +2 -2
- package/dist/internal/sidebar-responsive.d.ts +0 -1
- package/dist/internal/sidebar-responsive.d.ts.map +1 -1
- package/dist/internal/sidebar-responsive.js +0 -9
- package/dist/internal/sidebar-tree.d.ts.map +1 -1
- package/dist/internal/sidebar-tree.js +6 -1
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +80 -53
- package/dist/internal/table-of-contents.d.ts.map +1 -1
- package/dist/internal/table-of-contents.js +1 -1
- package/dist/internal/toc-items.d.ts.map +1 -1
- package/dist/internal/toc-items.js +19 -8
- package/dist/internal/ui/dropdown-menu.d.ts.map +1 -1
- package/dist/internal/ui/dropdown-menu.js +8 -8
- package/dist/internal/ui/navigation-menu.d.ts.map +1 -1
- package/dist/internal/ui/navigation-menu.js +4 -4
- package/dist/internal/ui/popover.js +1 -1
- package/dist/internal/ui/scroll-area.js +1 -1
- package/dist/internal/use-mobile.d.ts.map +1 -1
- package/dist/internal/use-mobile.js +2 -12
- package/dist/layout.d.ts +1 -0
- package/dist/layout.d.ts.map +1 -1
- package/dist/layout.js +2 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +20 -2
- package/dist/mobile-docs-bar.d.ts.map +1 -1
- package/dist/mobile-docs-bar.js +1 -2
- package/dist/navbar.js +3 -2
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +18 -5
- package/dist/providers/public/components/badge.d.ts +8 -0
- package/dist/providers/public/components/badge.d.ts.map +1 -0
- package/dist/providers/public/components/badge.js +10 -0
- package/dist/providers/public/components/button.d.ts +18 -0
- package/dist/providers/public/components/button.d.ts.map +1 -0
- package/dist/providers/public/components/button.js +24 -0
- package/dist/providers/public/components/code-block-server.d.ts +11 -0
- package/dist/providers/public/components/code-block-server.d.ts.map +1 -0
- package/dist/providers/public/components/code-block-server.js +26 -0
- package/dist/providers/public/components/code-block.d.ts +10 -0
- package/dist/providers/public/components/code-block.d.ts.map +1 -0
- package/dist/providers/public/components/code-block.js +3 -0
- package/dist/providers/public/components/copy-button.d.ts +7 -0
- package/dist/providers/public/components/copy-button.d.ts.map +1 -0
- package/dist/providers/public/components/copy-button.js +23 -0
- package/dist/providers/public/components/drawer.d.ts +13 -0
- package/dist/providers/public/components/drawer.d.ts.map +1 -0
- package/dist/providers/public/components/drawer.js +10 -0
- package/dist/providers/public/components/image.d.ts +7 -0
- package/dist/providers/public/components/image.d.ts.map +1 -0
- package/dist/providers/public/components/image.js +4 -0
- package/dist/providers/public/components/kbd.d.ts +7 -0
- package/dist/providers/public/components/kbd.d.ts.map +1 -0
- package/dist/providers/public/components/kbd.js +10 -0
- package/dist/providers/public/components/modal.d.ts +22 -0
- package/dist/providers/public/components/modal.d.ts.map +1 -0
- package/dist/providers/public/components/modal.js +19 -0
- package/dist/{internal/ui → providers/public/components}/sheet.d.ts +2 -1
- package/dist/providers/public/components/sheet.d.ts.map +1 -0
- package/dist/{internal/ui → providers/public/components}/sheet.js +5 -5
- package/dist/providers/public/components/skeleton.d.ts +10 -0
- package/dist/providers/public/components/skeleton.d.ts.map +1 -0
- package/dist/providers/public/components/skeleton.js +3 -0
- package/dist/{internal/ui → providers/public/components}/spinner.d.ts +1 -1
- package/dist/providers/public/components/spinner.d.ts.map +1 -0
- package/dist/providers/public/components/spinner.js +11 -0
- package/dist/providers/public/components/textarea.d.ts.map +1 -0
- package/dist/{internal/ui → providers/public/components}/textarea.js +1 -1
- package/dist/providers/public/components/theme-switcher.d.ts.map +1 -0
- package/dist/{components → providers/public/components}/theme-switcher.js +7 -7
- package/dist/providers/public/components/toasts.d.ts +10 -0
- package/dist/providers/public/components/toasts.d.ts.map +1 -0
- package/dist/providers/public/components/toasts.js +8 -0
- package/dist/providers/public/components/tooltip.d.ts +13 -0
- package/dist/providers/public/components/tooltip.d.ts.map +1 -0
- package/dist/providers/public/components/tooltip.js +5 -0
- package/dist/providers/public/core/fonts.d.ts +2 -0
- package/dist/providers/public/core/fonts.d.ts.map +1 -0
- package/dist/providers/public/core/fonts.js +24 -0
- package/dist/providers/public/core/provider.d.ts +8 -0
- package/dist/providers/public/core/provider.d.ts.map +1 -0
- package/dist/providers/public/core/provider.js +4 -0
- package/dist/providers/public/core/theme-script.d.ts +5 -0
- package/dist/providers/public/core/theme-script.d.ts.map +1 -0
- package/dist/providers/public/core/theme-script.js +7 -0
- package/dist/providers/public/core.d.ts +5 -0
- package/dist/providers/public/core.d.ts.map +1 -0
- package/dist/providers/public/core.js +4 -0
- package/dist/{internal/cn.d.ts → providers/public/utils.d.ts} +1 -1
- package/dist/providers/public/utils.d.ts.map +1 -0
- package/dist/providers/public-assets/icons/icon-check.d.ts +2 -0
- package/dist/providers/public-assets/icons/icon-check.d.ts.map +1 -0
- package/dist/providers/public-assets/icons/icon-check.js +1 -0
- package/dist/providers/public-assets/icons/icon-chevron-down-small.d.ts +2 -0
- package/dist/providers/public-assets/icons/icon-chevron-down-small.d.ts.map +1 -0
- package/dist/providers/public-assets/icons/icon-chevron-down-small.js +1 -0
- package/dist/providers/public-assets/icons/icon-copy.d.ts +2 -0
- package/dist/providers/public-assets/icons/icon-copy.d.ts.map +1 -0
- package/dist/providers/public-assets/icons/icon-copy.js +1 -0
- package/dist/providers/public-assets/icons.d.ts +40 -0
- package/dist/providers/public-assets/icons.d.ts.map +1 -0
- package/dist/providers/public-assets/icons.js +39 -0
- package/dist/providers/public-assets/logos.d.ts +9 -0
- package/dist/providers/public-assets/logos.d.ts.map +1 -0
- package/dist/providers/public-assets/logos.js +8 -0
- package/dist/proxy.d.ts.map +1 -1
- package/dist/proxy.js +12 -26
- package/dist/routes/chat.d.ts +1 -1
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +31 -14
- package/dist/routes/llms.d.ts +1 -1
- package/dist/routes/llms.d.ts.map +1 -1
- package/dist/routes/llms.js +12 -2
- package/dist/routes/not-found.d.ts.map +1 -1
- package/dist/routes/not-found.js +3 -3
- package/dist/source-config.d.ts +10 -0
- package/dist/source-config.d.ts.map +1 -1
- package/dist/source-config.js +20 -2
- package/dist/source.d.ts +10 -1
- package/dist/source.d.ts.map +1 -1
- package/dist/source.js +75 -36
- package/dist/versions.d.ts.map +1 -1
- package/dist/versions.js +5 -5
- package/docs/agents.md +5 -4
- package/docs/llms.txt +520 -140
- package/docs/manifest.json +21 -12
- package/docs/pages/ask-ai.md +3 -4
- package/docs/pages/components/steps.md +129 -0
- package/docs/pages/deployment.md +6 -3
- package/docs/pages/getting-started.md +23 -29
- package/docs/pages/guides/nested-navigation.md +1 -1
- package/docs/pages/md.md +25 -6
- package/docs/pages/migration.md +11 -15
- package/docs/pages/packages.md +54 -0
- package/docs/pages/proxy.md +7 -1
- package/docs/pages/syntax.md +246 -11
- package/docs/pages/versioned-docs.md +2 -3
- package/docs/sitemap.md +4 -3
- package/package.json +36 -90
- package/public-foundation.css +681 -0
- package/shared-theme.css +349 -0
- package/source-config.js +37 -2
- package/styles.css +1 -2
- package/template/AGENTS.md +15 -6
- package/template/app/[lang]/(home)/components/cta.tsx +8 -3
- package/template/app/[lang]/(home)/components/hero.tsx +1 -1
- package/template/app/[lang]/(home)/components/one-two-section.tsx +9 -1
- package/template/app/[lang]/(home)/components/text-grid-section.tsx +1 -1
- package/template/app/[lang]/(home)/page.tsx +5 -6
- package/template/app/[lang]/layout.tsx +11 -4
- package/template/app/styles/geistdocs.css +13 -18
- package/template/components.json +0 -1
- package/template/content/docs/ask-ai.cn.mdx +2 -2
- package/template/content/docs/ask-ai.mdx +3 -4
- package/template/content/docs/components/meta.json +4 -0
- package/template/content/docs/components/steps.mdx +125 -0
- package/template/content/docs/configuration.cn.mdx +1 -3
- package/template/content/docs/deployment.mdx +8 -4
- package/template/content/docs/getting-started.mdx +24 -30
- package/template/content/docs/guides/nested-navigation.mdx +1 -1
- package/template/content/docs/md.mdx +25 -6
- package/template/content/docs/meta.json +3 -0
- package/template/content/docs/migration.mdx +12 -16
- package/template/content/docs/packages.mdx +53 -0
- package/template/content/docs/proxy.cn.mdx +1 -1
- package/template/content/docs/proxy.mdx +7 -1
- package/template/content/docs/syntax.mdx +252 -11
- package/template/content/docs/versioned-docs.mdx +2 -3
- package/template/next.config.ts +9 -1
- package/template/package.json +2 -8
- package/theme.css +2 -955
- package/dist/components/badge.d.ts +0 -11
- package/dist/components/badge.d.ts.map +0 -1
- package/dist/components/badge.js +0 -22
- package/dist/components/button-group.d.ts +0 -2
- package/dist/components/button-group.d.ts.map +0 -1
- package/dist/components/button-group.js +0 -2
- package/dist/components/button.d.ts +0 -2
- package/dist/components/button.d.ts.map +0 -1
- package/dist/components/button.js +0 -2
- package/dist/components/card.d.ts +0 -2
- package/dist/components/card.d.ts.map +0 -1
- package/dist/components/card.js +0 -2
- package/dist/components/dialog.d.ts +0 -13
- package/dist/components/dialog.d.ts.map +0 -1
- package/dist/components/dialog.js +0 -35
- package/dist/components/drawer.d.ts +0 -2
- package/dist/components/drawer.d.ts.map +0 -1
- package/dist/components/drawer.js +0 -3
- package/dist/components/input-group.d.ts +0 -2
- package/dist/components/input-group.d.ts.map +0 -1
- package/dist/components/input-group.js +0 -3
- package/dist/components/input.d.ts +0 -2
- package/dist/components/input.d.ts.map +0 -1
- package/dist/components/input.js +0 -2
- package/dist/components/kbd.d.ts +0 -2
- package/dist/components/kbd.d.ts.map +0 -1
- package/dist/components/kbd.js +0 -2
- package/dist/components/separator.d.ts +0 -2
- package/dist/components/separator.d.ts.map +0 -1
- package/dist/components/separator.js +0 -3
- package/dist/components/sheet.d.ts +0 -2
- package/dist/components/sheet.d.ts.map +0 -1
- package/dist/components/sheet.js +0 -3
- package/dist/components/sonner.d.ts +0 -2
- package/dist/components/sonner.d.ts.map +0 -1
- package/dist/components/sonner.js +0 -3
- package/dist/components/spinner.d.ts +0 -2
- package/dist/components/spinner.d.ts.map +0 -1
- package/dist/components/spinner.js +0 -2
- package/dist/components/switch.d.ts +0 -11
- package/dist/components/switch.d.ts.map +0 -1
- package/dist/components/switch.js +0 -12
- package/dist/components/textarea.d.ts +0 -2
- package/dist/components/textarea.d.ts.map +0 -1
- package/dist/components/textarea.js +0 -2
- package/dist/components/theme-aware-image.d.ts +0 -12
- package/dist/components/theme-aware-image.d.ts.map +0 -1
- package/dist/components/theme-aware-image.js +0 -8
- package/dist/components/theme-switcher.d.ts.map +0 -1
- package/dist/components/tooltip.d.ts +0 -2
- package/dist/components/tooltip.d.ts.map +0 -1
- package/dist/components/tooltip.js +0 -3
- package/dist/internal/chat/shimmer.d.ts +0 -11
- package/dist/internal/chat/shimmer.d.ts.map +0 -1
- package/dist/internal/chat/shimmer.js +0 -22
- package/dist/internal/cn.d.ts.map +0 -1
- package/dist/internal/ui/button-group.d.ts +0 -13
- package/dist/internal/ui/button-group.d.ts.map +0 -1
- package/dist/internal/ui/button-group.js +0 -26
- package/dist/internal/ui/button.d.ts +0 -12
- package/dist/internal/ui/button.d.ts.map +0 -1
- package/dist/internal/ui/button.js +0 -33
- package/dist/internal/ui/card.d.ts +0 -6
- package/dist/internal/ui/card.d.ts.map +0 -1
- package/dist/internal/ui/card.js +0 -14
- package/dist/internal/ui/drawer.d.ts +0 -8
- package/dist/internal/ui/drawer.d.ts.map +0 -1
- package/dist/internal/ui/drawer.js +0 -19
- package/dist/internal/ui/input-group.d.ts +0 -15
- package/dist/internal/ui/input-group.d.ts.map +0 -1
- package/dist/internal/ui/input-group.js +0 -44
- package/dist/internal/ui/input.d.ts +0 -3
- package/dist/internal/ui/input.d.ts.map +0 -1
- package/dist/internal/ui/input.js +0 -5
- package/dist/internal/ui/kbd.d.ts +0 -4
- package/dist/internal/ui/kbd.d.ts.map +0 -1
- package/dist/internal/ui/kbd.js +0 -8
- package/dist/internal/ui/separator.d.ts +0 -4
- package/dist/internal/ui/separator.d.ts.map +0 -1
- package/dist/internal/ui/separator.js +0 -7
- package/dist/internal/ui/sheet.d.ts.map +0 -1
- package/dist/internal/ui/sonner.d.ts +0 -3
- package/dist/internal/ui/sonner.d.ts.map +0 -1
- package/dist/internal/ui/sonner.js +0 -20
- package/dist/internal/ui/spinner.d.ts.map +0 -1
- package/dist/internal/ui/spinner.js +0 -6
- package/dist/internal/ui/textarea.d.ts.map +0 -1
- package/dist/internal/ui/tooltip.d.ts +0 -7
- package/dist/internal/ui/tooltip.d.ts.map +0 -1
- package/dist/internal/ui/tooltip.js +0 -16
- package/docs/pages/theme-aware-image.md +0 -59
- package/template/app/[lang]/(home)/components/centered-section.tsx +0 -32
- package/template/components/ui/button.tsx +0 -60
- package/template/content/docs/theme-aware-image.mdx +0 -57
- /package/dist/{internal/ui → providers/public/components}/textarea.d.ts +0 -0
- /package/dist/{components → providers/public/components}/theme-switcher.d.ts +0 -0
- /package/dist/{internal/cn.js → providers/public/utils.js} +0 -0
package/docs/manifest.json
CHANGED
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"description": "Learn how to deploy your Geistdocs site to Vercel",
|
|
40
40
|
"path": "pages/deployment.md",
|
|
41
41
|
"source": "apps/template/content/docs/deployment.mdx",
|
|
42
|
-
"summary": "Deploy a Geistdocs site to Vercel with the required project settings
|
|
42
|
+
"summary": "Deploy a Geistdocs site to Vercel with the required project settings and environment variables.",
|
|
43
43
|
"title": "Deploy to Vercel",
|
|
44
44
|
"type": "guide",
|
|
45
45
|
"url": "/docs/deployment"
|
|
@@ -49,10 +49,19 @@
|
|
|
49
49
|
"path": "pages/migration.md",
|
|
50
50
|
"source": "apps/template/content/docs/migration.mdx",
|
|
51
51
|
"summary": "Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.",
|
|
52
|
-
"title": "
|
|
52
|
+
"title": "Migrate to Geistdocs",
|
|
53
53
|
"type": "guide",
|
|
54
54
|
"url": "/docs/migration"
|
|
55
55
|
},
|
|
56
|
+
{
|
|
57
|
+
"description": "Choose between the public Geistdocs package and Vercel's private Geistcn-backed package",
|
|
58
|
+
"path": "pages/packages.md",
|
|
59
|
+
"source": "apps/template/content/docs/packages.mdx",
|
|
60
|
+
"summary": "Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.",
|
|
61
|
+
"title": "Choose a Geistdocs package",
|
|
62
|
+
"type": "guide",
|
|
63
|
+
"url": "/docs/packages"
|
|
64
|
+
},
|
|
56
65
|
{
|
|
57
66
|
"description": "Configure a Geistdocs site through local adapter files and package APIs",
|
|
58
67
|
"path": "pages/configuration.md",
|
|
@@ -206,6 +215,15 @@
|
|
|
206
215
|
"type": "conceptual",
|
|
207
216
|
"url": "/docs/rss"
|
|
208
217
|
},
|
|
218
|
+
{
|
|
219
|
+
"description": "Render numbered step-by-step instructions from Markdown headings or the Steps and Step components",
|
|
220
|
+
"path": "pages/components/steps.md",
|
|
221
|
+
"source": "apps/template/content/docs/components/steps.mdx",
|
|
222
|
+
"summary": "Write consecutive headings that start with a number, such as \"### 1. Install\", to render a numbered step list. The Steps and Step components cover cases where a heading must be wrapped in another component.",
|
|
223
|
+
"title": "Steps",
|
|
224
|
+
"type": "reference",
|
|
225
|
+
"url": "/docs/components/steps"
|
|
226
|
+
},
|
|
209
227
|
{
|
|
210
228
|
"description": "Show an \"On this page\" outline that tracks the reader's position along a straight guide rail",
|
|
211
229
|
"path": "pages/table-of-contents.md",
|
|
@@ -215,15 +233,6 @@
|
|
|
215
233
|
"type": "reference",
|
|
216
234
|
"url": "/docs/table-of-contents"
|
|
217
235
|
},
|
|
218
|
-
{
|
|
219
|
-
"description": "Display different images based on the user's light or dark theme preference",
|
|
220
|
-
"path": "pages/theme-aware-image.md",
|
|
221
|
-
"source": "apps/template/content/docs/theme-aware-image.mdx",
|
|
222
|
-
"summary": "A component that swaps images based on the active theme, built on top of Next.js Image.",
|
|
223
|
-
"title": "Theme-Aware Image",
|
|
224
|
-
"type": "reference",
|
|
225
|
-
"url": "/docs/theme-aware-image"
|
|
226
|
-
},
|
|
227
236
|
{
|
|
228
237
|
"description": "Expose documentation search and page reading to browser agents.",
|
|
229
238
|
"path": "pages/webmcp.md",
|
|
@@ -233,5 +242,5 @@
|
|
|
233
242
|
}
|
|
234
243
|
],
|
|
235
244
|
"source": "apps/template/content/docs",
|
|
236
|
-
"version": "
|
|
245
|
+
"version": "2.0.0"
|
|
237
246
|
}
|
package/docs/pages/ask-ai.md
CHANGED
|
@@ -42,7 +42,6 @@ Users can open the chat interface at any time by:
|
|
|
42
42
|
Once open, users can:
|
|
43
43
|
|
|
44
44
|
- Ask questions about any part of your documentation
|
|
45
|
-
- Expand the desktop panel to a full-screen view for wide responses and code blocks
|
|
46
45
|
- Upload files or images for context
|
|
47
46
|
- View AI-powered search results from your docs
|
|
48
47
|
- Get step-by-step guidance on complex topics
|
|
@@ -95,7 +94,7 @@ In this mode, Geistdocs uses the local `search_docs` tool during the AI SDK `str
|
|
|
95
94
|
|
|
96
95
|
#### Choose a model
|
|
97
96
|
|
|
98
|
-
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-
|
|
97
|
+
Pass the `model` option to `createChatRoute` to control which model answers Ask AI requests. It accepts any AI SDK `LanguageModel`, including AI Gateway model strings, and defaults to `openai/gpt-5.6-sol`.
|
|
99
98
|
|
|
100
99
|
```ts title="app/api/chat/route.ts"
|
|
101
100
|
import { createChatRoute } from "@vercel/geistdocs/routes/chat";
|
|
@@ -199,14 +198,14 @@ Conversations are automatically saved to the browser's IndexedDB, providing:
|
|
|
199
198
|
|
|
200
199
|
The chat interface adapts to different screen sizes:
|
|
201
200
|
|
|
202
|
-
- **Desktop**: Slides in from the right side as a sidebar panel
|
|
201
|
+
- **Desktop**: Slides in from the right side as a sidebar panel
|
|
203
202
|
- **Mobile**: Opens as a bottom drawer.
|
|
204
203
|
|
|
205
204
|
## Configuration
|
|
206
205
|
|
|
207
206
|
The environment variables `AI_GATEWAY_API_KEY` and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` must be set for the default AI Gateway mode. Set `GEISTDOCS_CHAT_PROXY_URL` to route Ask AI through a Vertex-backed proxy instead. You can read more in the [Environment Variables](/docs/env) section.
|
|
208
207
|
|
|
209
|
-
In default AI Gateway mode, Geistdocs uses `openai/gpt-
|
|
208
|
+
In default AI Gateway mode, Geistdocs uses `openai/gpt-5.6-sol` via the Vercel AI Gateway. In Vertex-backed proxy mode, the configured proxy controls the upstream model.
|
|
210
209
|
|
|
211
210
|
## Suggested Prompts
|
|
212
211
|
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Steps
|
|
3
|
+
description: Render numbered step-by-step instructions from Markdown headings or the Steps and Step components
|
|
4
|
+
type: reference
|
|
5
|
+
summary: Write consecutive headings that start with a number, such as "### 1. Install", to render a numbered step list. The Steps and Step components cover cases where a heading must be wrapped in another component.
|
|
6
|
+
url: /docs/components/steps
|
|
7
|
+
source: apps/template/content/docs/components/steps.mdx
|
|
8
|
+
prerequisites:
|
|
9
|
+
- /docs/syntax
|
|
10
|
+
related:
|
|
11
|
+
- /docs/syntax
|
|
12
|
+
- /docs/table-of-contents
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Steps
|
|
16
|
+
|
|
17
|
+
Steps render sequential instructions as a numbered list with a counter beside each step heading. You write them as plain Markdown headings, so a page needs no imports and stays readable in Markdown output.
|
|
18
|
+
|
|
19
|
+
## Write steps as numbered headings
|
|
20
|
+
|
|
21
|
+
Start each step heading with a number, a period, and a space. Consecutive headings at the same depth that follow this pattern become one step list.
|
|
22
|
+
|
|
23
|
+
````md
|
|
24
|
+
## Deploy the project
|
|
25
|
+
|
|
26
|
+
### 1. Install the CLI
|
|
27
|
+
|
|
28
|
+
Install the Vercel CLI globally.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pnpm add -g vercel
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### 2. Link the project
|
|
35
|
+
|
|
36
|
+
Run `vercel link` in the project directory and pick the team and project.
|
|
37
|
+
|
|
38
|
+
### 3. Deploy
|
|
39
|
+
|
|
40
|
+
Run `vercel deploy` to create a preview deployment.
|
|
41
|
+
|
|
42
|
+
## Next section
|
|
43
|
+
````
|
|
44
|
+
|
|
45
|
+
This renders as:
|
|
46
|
+
|
|
47
|
+
### 1. Install the CLI
|
|
48
|
+
|
|
49
|
+
Install the Vercel CLI globally.
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
pnpm add -g vercel
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 2. Link the project
|
|
56
|
+
|
|
57
|
+
Run `vercel link` in the project directory and pick the team and project.
|
|
58
|
+
|
|
59
|
+
### 3. Deploy
|
|
60
|
+
|
|
61
|
+
Run `vercel deploy` to create a preview deployment.
|
|
62
|
+
|
|
63
|
+
## How numbering and anchors work
|
|
64
|
+
|
|
65
|
+
Geistdocs removes the `1. ` prefix from the heading text at build time and draws the number with a CSS counter. As a result:
|
|
66
|
+
|
|
67
|
+
- The table of contents shows `Install the CLI`, not `1. Install the CLI`.
|
|
68
|
+
- The heading anchor is `#install-the-cli`, so renumbering steps does not break links.
|
|
69
|
+
- Custom anchors written as `### 1. Install the CLI [#install]` keep working.
|
|
70
|
+
- Markdown routes and `llms.txt` output numbered headings, such as `### 1. Install the CLI`, which read naturally for agents.
|
|
71
|
+
|
|
72
|
+
The numbers you write are only used to detect steps. Geistdocs always counts from 1, so `### 4. Deploy` at the start of a list renders as step 1.
|
|
73
|
+
|
|
74
|
+
## Rules for grouping steps
|
|
75
|
+
|
|
76
|
+
Geistdocs groups headings into a step list using these rules:
|
|
77
|
+
|
|
78
|
+
| Situation | Result |
|
|
79
|
+
| --- | --- |
|
|
80
|
+
| Consecutive numbered headings at the same depth | One step list |
|
|
81
|
+
| A deeper heading inside a step, such as `#### Options` under `### 2. Configure` | Part of the current step |
|
|
82
|
+
| A heading at the same or shallower depth without a number prefix | Ends the step list |
|
|
83
|
+
| A numbered heading where inline code or a link immediately follows the number, such as `` ### 1. `vercel login` `` | Not detected as a step; move a word before the code, such as `` ### 1. Run `vercel login` `` |
|
|
84
|
+
|
|
85
|
+
Paragraphs, lists, code blocks, callouts, and images between two step headings belong to the earlier step.
|
|
86
|
+
|
|
87
|
+
## Use the Steps and Step components
|
|
88
|
+
|
|
89
|
+
Use the components when a step heading has to be wrapped in another component, for example a framework switcher, and the heading pattern cannot be detected. Both components are in the default MDX component map and are exported from the selected package's `components/steps` subpath.
|
|
90
|
+
|
|
91
|
+
```mdx
|
|
92
|
+
<Steps>
|
|
93
|
+
<Step>
|
|
94
|
+
### Install the package
|
|
95
|
+
|
|
96
|
+
Run the install command for your package manager.
|
|
97
|
+
</Step>
|
|
98
|
+
<Step>
|
|
99
|
+
### Configure the project
|
|
100
|
+
|
|
101
|
+
Add the configuration file to the project root.
|
|
102
|
+
</Step>
|
|
103
|
+
</Steps>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
This renders as:
|
|
107
|
+
|
|
108
|
+
<Steps>
|
|
109
|
+
<Step>
|
|
110
|
+
### Install the package
|
|
111
|
+
|
|
112
|
+
Run the install command for your package manager.
|
|
113
|
+
</Step>
|
|
114
|
+
<Step>
|
|
115
|
+
### Configure the project
|
|
116
|
+
|
|
117
|
+
Add the configuration file to the project root.
|
|
118
|
+
</Step>
|
|
119
|
+
</Steps>
|
|
120
|
+
|
|
121
|
+
Do not add a number prefix to headings inside `Step`. The component draws the counter, and a prefix would create a nested step list.
|
|
122
|
+
|
|
123
|
+
### Props
|
|
124
|
+
|
|
125
|
+
`Steps` and `Step` accept the standard `div` attributes. Both forward `className`, which is merged with the `fd-steps` and `fd-step` classes that carry the counter styling.
|
|
126
|
+
|
|
127
|
+
## Markdown output
|
|
128
|
+
|
|
129
|
+
In `.md` routes and `llms.txt`, each step list becomes plain numbered headings, such as `### 1. Install the CLI`, followed by the step content. This applies to steps written as headings and to steps written with `Steps` and `Step`, so agents read the same sequence without the wrapper markup.
|
package/docs/pages/deployment.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Deploy to Vercel
|
|
3
3
|
description: Learn how to deploy your Geistdocs site to Vercel
|
|
4
4
|
type: guide
|
|
5
|
-
summary: Deploy a Geistdocs site to Vercel with the required project settings
|
|
5
|
+
summary: Deploy a Geistdocs site to Vercel with the required project settings and environment variables.
|
|
6
6
|
url: /docs/deployment
|
|
7
7
|
source: apps/template/content/docs/deployment.mdx
|
|
8
8
|
prerequisites:
|
|
@@ -14,9 +14,12 @@ related:
|
|
|
14
14
|
|
|
15
15
|
# Deploy to Vercel
|
|
16
16
|
|
|
17
|
-
Deploy a Geistdocs site to Vercel as a Next.js app. Configure
|
|
17
|
+
Deploy a Geistdocs site to Vercel as a Next.js app. Configure environment variables and the production URL before shipping. Public `@vercel/geistdocs` projects require no private npm access.
|
|
18
18
|
|
|
19
|
-
Help me deploy this Geistdocs project to Vercel.
|
|
19
|
+
Help me deploy this Geistdocs project to Vercel. Review the selected package, scripts, environment variables, GitHub Actions authentication, and Vercel project settings. Verify private npm access only for `@vercel/geistdocs-private`.
|
|
20
|
+
|
|
21
|
+
> Note:
|
|
22
|
+
`@vercel/geistdocs-private` depends on the restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Use it only in internal environments such as `front`, where installs and deployments already have access. Public repositories, including Vercel-owned OSS projects, should use `@vercel/geistdocs`.
|
|
20
23
|
|
|
21
24
|
## Prerequisites
|
|
22
25
|
|
|
@@ -14,9 +14,9 @@ related:
|
|
|
14
14
|
|
|
15
15
|
# Getting Started
|
|
16
16
|
|
|
17
|
-
Create a Geistdocs site with the package CLI, then
|
|
17
|
+
Create a new Geistdocs site with the package CLI, then customize its identity, content, and navigation. If you already have a documentation site, use [Migrate to Geistdocs](/docs/migration). Read [Choose a Geistdocs package](/docs/packages) before using the private package.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Create a new Geistdocs project with `pnpm dlx @vercel/geistdocs@latest init --name my-docs`. Confirm the prerequisites, run `pnpm dev`, and help me customize `geistdocs.tsx`, `content/docs/index.mdx`, and `content/docs/meta.json`. Keep the generated integrations package-backed.
|
|
20
20
|
|
|
21
21
|
## Prerequisites
|
|
22
22
|
|
|
@@ -26,25 +26,7 @@ Before you begin, install:
|
|
|
26
26
|
- pnpm
|
|
27
27
|
- Git
|
|
28
28
|
|
|
29
|
-
The
|
|
30
|
-
|
|
31
|
-
## Choose a release channel
|
|
32
|
-
|
|
33
|
-
Use `@vercel/geistdocs@latest` for the current stable package-backed release. Use `@vercel/geistdocs@canary` only when you need changes being evaluated on the `canary` branch, including the current Geistcn migration.
|
|
34
|
-
|
|
35
|
-
The canary dist-tag can move several times in one day. The CLI resolves the tag once and writes that exact version to the generated `package.json`.
|
|
36
|
-
|
|
37
|
-
## Authenticate for the Geistcn canary
|
|
38
|
-
|
|
39
|
-
The Geistcn canary depends on restricted `@vercel/geistcn` and `@vercel/geistcn-assets` packages. Configure npm authentication before running the canary CLI. Add this configuration to your user-level `~/.npmrc`:
|
|
40
|
-
|
|
41
|
-
```ini title="~/.npmrc"
|
|
42
|
-
@vercel:registry=https://registry.npmjs.org/
|
|
43
|
-
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
|
|
44
|
-
always-auth=true
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Set `NPM_TOKEN` from an approved internal source and keep its value out of files and Git. Stable Geistdocs does not currently require these restricted packages. Read [Deploy to Vercel](/docs/deployment) before configuring automated installs.
|
|
29
|
+
The CLI always uses pnpm to install the generated project's dependencies.
|
|
48
30
|
|
|
49
31
|
## Create a project
|
|
50
32
|
|
|
@@ -54,19 +36,13 @@ Run the Geistdocs CLI from an empty parent folder. For stable Geistdocs, run:
|
|
|
54
36
|
pnpm dlx @vercel/geistdocs@latest init --name my-docs
|
|
55
37
|
```
|
|
56
38
|
|
|
57
|
-
For the Geistcn canary, run:
|
|
58
|
-
|
|
59
|
-
```bash title="Terminal"
|
|
60
|
-
pnpm dlx @vercel/geistdocs@canary init --name my-docs
|
|
61
|
-
```
|
|
62
|
-
|
|
63
39
|
The CLI copies the template bundled in the package, rewrites the generated app to depend on the same `@vercel/geistdocs` version, installs dependencies, copies `.env.example` to `.env.local`, and initializes Git.
|
|
64
40
|
|
|
65
41
|
## Understand generated dependencies
|
|
66
42
|
|
|
67
|
-
Generated projects include
|
|
43
|
+
Generated projects pin the resolved package version and include AI SDK v6 and `@ai-sdk/react` v3. The public package does not require private npm access. The template already configures styles, fonts, Cache Components, Partial Prefetching, source adapters, search, Ask AI, and agent-readable routes.
|
|
68
44
|
|
|
69
|
-
|
|
45
|
+
Keep those integrations package-backed. Update Geistdocs instead of copying package internals into the app.
|
|
70
46
|
|
|
71
47
|
## Start the development server
|
|
72
48
|
|
|
@@ -79,6 +55,14 @@ pnpm dev
|
|
|
79
55
|
|
|
80
56
|
Open `http://localhost:3000` in your browser.
|
|
81
57
|
|
|
58
|
+
Start with these files:
|
|
59
|
+
|
|
60
|
+
- `geistdocs.tsx` for the site title, logo, navigation, repository, and AI prompt.
|
|
61
|
+
- `content/docs/index.mdx` for the documentation overview.
|
|
62
|
+
- `content/docs/meta.json` for sidebar order and groups.
|
|
63
|
+
|
|
64
|
+
Only customize `components/geistdocs/*`, `lib/geistdocs/*`, or route adapters when the generated defaults do not fit your site.
|
|
65
|
+
|
|
82
66
|
## Edit your first page
|
|
83
67
|
|
|
84
68
|
Docs live in `content/docs`. Edit the overview page:
|
|
@@ -136,3 +120,13 @@ pnpm exec geistdocs update
|
|
|
136
120
|
```
|
|
137
121
|
|
|
138
122
|
Review and test dependency changes before committing.
|
|
123
|
+
|
|
124
|
+
## Verify and deploy
|
|
125
|
+
|
|
126
|
+
Run a production build before publishing:
|
|
127
|
+
|
|
128
|
+
```bash title="Terminal"
|
|
129
|
+
pnpm build
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Then follow [Deploy to Vercel](/docs/deployment), including environment-variable setup. Private-package access is required only for `@vercel/geistdocs-private`.
|
|
@@ -200,7 +200,7 @@ Geistdocs applies a color for each method:
|
|
|
200
200
|
| `PUT`, `PATCH` | Amber |
|
|
201
201
|
| `DEL`, `DELETE` | Red |
|
|
202
202
|
|
|
203
|
-
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge.
|
|
203
|
+
Method matching is case-sensitive, so use uppercase labels. `DEL` and `DELETE` render the same red badge, so prefer `DEL` when you want a narrower badge. `New` renders as a low-contrast blue badge; other labels, such as `Beta`, use the default neutral badge. Badge colors adapt to light and dark themes automatically.
|
|
204
204
|
|
|
205
205
|
## Add links to the navigation
|
|
206
206
|
|
package/docs/pages/md.md
CHANGED
|
@@ -13,7 +13,7 @@ related:
|
|
|
13
13
|
|
|
14
14
|
# .md Extension
|
|
15
15
|
|
|
16
|
-
Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the
|
|
16
|
+
Geistdocs lets AI tools and language models access documentation pages as plain Markdown. Append `.md` or `.mdx` to a documentation URL to get the page content with presentation-only MDX components removed.
|
|
17
17
|
|
|
18
18
|
Help me test raw Markdown routes in this Geistdocs project. Fetch a docs page with `.mdx` appended, compare it to the rendered page, and explain how AI tools can use it.
|
|
19
19
|
|
|
@@ -33,8 +33,8 @@ https://yourdomain.com/docs/getting-started.mdx
|
|
|
33
33
|
|
|
34
34
|
The `.mdx` version returns:
|
|
35
35
|
|
|
36
|
-
-
|
|
37
|
-
- The full
|
|
36
|
+
- Frontmatter with the canonical page URL, docs index, and last-updated date when available
|
|
37
|
+
- The full page content as plain Markdown
|
|
38
38
|
- No HTML, styling, or navigation
|
|
39
39
|
|
|
40
40
|
For a docs section mounted at `/docs`, the section root remains `/docs.md`. For a source mounted at the app root with `baseUrl: "/"`, Geistdocs uses `/index.md` for the root page. If Next.js has `basePath: "/docs"`, that public root Markdown URL is `/docs/index.md`.
|
|
@@ -83,11 +83,30 @@ The response includes:
|
|
|
83
83
|
|
|
84
84
|
- Content-Type: `text/markdown`
|
|
85
85
|
- `Link: <canonical page URL>; rel="canonical"` for resolved pages
|
|
86
|
-
-
|
|
87
|
-
-
|
|
86
|
+
- Frontmatter with page metadata and discovery links
|
|
87
|
+
- Page content with presentation-only MDX components removed
|
|
88
88
|
|
|
89
89
|
All MDX components are processed and converted to plain Markdown equivalents.
|
|
90
90
|
|
|
91
|
+
### Customize frontmatter
|
|
92
|
+
|
|
93
|
+
Geistdocs generates `title`, `description`, `url`, `docs_index`, and `lastUpdated` when their values are available, along with supported page frontmatter such as `prerequisites` and `related`. Add product-specific fields or override defaults with the source `markdown.frontmatter` hook:
|
|
94
|
+
|
|
95
|
+
```ts title="lib/geistdocs/source.ts"
|
|
96
|
+
export const geistdocsSource = createSource({
|
|
97
|
+
config,
|
|
98
|
+
docs,
|
|
99
|
+
markdown: {
|
|
100
|
+
frontmatter: (defaults) => ({
|
|
101
|
+
docs_index: "/docs/llms.txt",
|
|
102
|
+
version: "16.3.4",
|
|
103
|
+
}),
|
|
104
|
+
},
|
|
105
|
+
});
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
The callback returns only additions and overrides; Geistdocs keeps the remaining generated fields from `defaults`.
|
|
109
|
+
|
|
91
110
|
## Missing documentation pages
|
|
92
111
|
|
|
93
112
|
When a Markdown request does not match a page, Geistdocs returns an agent-readable `Page Not Found` response. It compares the requested path with visible page paths and titles, then links up to five likely matches with their descriptions. If no match is useful, the response links to `/llms.txt` instead.
|
|
@@ -111,7 +130,7 @@ Set `notFound.getPageMarkdownUrl` as well when suggested pages use a custom app-
|
|
|
111
130
|
|
|
112
131
|
### Unmatched application paths
|
|
113
132
|
|
|
114
|
-
When `agent` is enabled, `createGeistdocs` scans App Router pages and route handlers during `next dev` and `next build`. `createProxy` uses that generated manifest to distinguish valid application routes from unknown paths. Valid routes continue to the app's HTML or route-handler response. Unknown
|
|
133
|
+
When `agent` is enabled, `createGeistdocs` scans App Router pages and route handlers during `next dev` and `next build`. `createProxy` uses that generated manifest to distinguish valid application routes from unknown paths. Valid routes continue to the app's HTML or route-handler response. Unknown `GET` and `HEAD` requests receive a concise Markdown 404 when the client prefers Markdown or when agent detection applies as a fallback. An explicit HTML preference keeps the app's normal HTML recovery.
|
|
115
134
|
|
|
116
135
|
Markdown mappings take precedence over generated app routes, so a route that has both HTML and Markdown continues to negotiate Markdown. Dynamic app routes are treated as potentially valid; the app remains responsible for returning its own 404 when a specific slug does not exist.
|
|
117
136
|
|
package/docs/pages/migration.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: Migrate to Geistdocs
|
|
3
3
|
description: Migrate a Fumadocs or custom Geist docs site to package-backed Geistdocs
|
|
4
4
|
type: guide
|
|
5
5
|
summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
@@ -14,14 +14,14 @@ related:
|
|
|
14
14
|
- /docs/agent-readiness
|
|
15
15
|
---
|
|
16
16
|
|
|
17
|
-
#
|
|
17
|
+
# Migrate to Geistdocs
|
|
18
18
|
|
|
19
19
|
Migrate an existing Fumadocs or custom Geist documentation site to `@vercel/geistdocs` by moving shared behavior into package APIs and keeping site-specific adapters local. The safest migration keeps content, routing decisions, and product-specific UI in your app while replacing copied runtime code with thin package-backed adapters.
|
|
20
20
|
|
|
21
21
|
> Note:
|
|
22
|
-
|
|
22
|
+
Use `@vercel/geistdocs` by default, including in Vercel-owned OSS repositories. Use `@vercel/geistdocs-private` only in an internal environment that already has private npm access. See [Choose a Geistdocs package](/docs/packages).
|
|
23
23
|
|
|
24
|
-
Help me migrate this existing docs site to package-backed Geistdocs.
|
|
24
|
+
Help me migrate this existing docs site to package-backed Geistdocs. Inspect `source.config.ts`, `lib/geistdocs/source.ts`, app route files, `proxy.ts` or `middleware.ts`, `public/llms.txt`, Open Graph routes, Tailwind CSS setup, `package.json` AI SDK dependencies, and environment variables. Then produce a step-by-step migration plan using `@vercel/geistdocs` package APIs without copying package internals.
|
|
25
25
|
|
|
26
26
|
## Before you migrate
|
|
27
27
|
|
|
@@ -48,7 +48,9 @@ Fix unrelated build failures first. A migration is safer when the starting point
|
|
|
48
48
|
|
|
49
49
|
## Install Geistdocs
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
Add `@vercel/geistdocs` and align the supported Fumadocs and Next.js dependencies for the package version you are adopting. Geistdocs requires Next.js 16.3.3 or later within 16.x. Earlier 16.3 releases can retain an optional catch-all route's index content after a client navigation to a child page when Cache Components and Partial Prefetching are enabled.
|
|
52
|
+
|
|
53
|
+
For an existing project, use your package manager directly:
|
|
52
54
|
|
|
53
55
|
```bash title="Terminal"
|
|
54
56
|
pnpm add --save-exact @vercel/geistdocs@latest
|
|
@@ -109,7 +111,8 @@ Replace imports according to this table:
|
|
|
109
111
|
|
|
110
112
|
| Previous Geistdocs import | Replacement |
|
|
111
113
|
| --- | --- |
|
|
112
|
-
| `components/badge`, `components/button`,
|
|
114
|
+
| `components/badge`, `components/button`, or `components/theme-switcher` | Keep the import package-backed. Geistdocs resolves these template primitives through the selected public or private provider. |
|
|
115
|
+
| `components/dialog`, `components/drawer`, `components/input`, `components/kbd`, `components/separator`, `components/sheet`, `components/spinner`, `components/textarea`, or `components/tooltip` | Import the matching component directly from `@vercel/geistcn/components/<name>` in approved private projects, or keep an application-owned public equivalent. |
|
|
113
116
|
| `components/switch` | Import toggle controls from `@vercel/geistcn/components/toggle`. |
|
|
114
117
|
| `components/sonner` | Use `Toasts` and `useToasts` from `@vercel/geistcn/components/toasts`. |
|
|
115
118
|
| `components/theme-aware-image` | Use `Image` from `@vercel/geistcn/components/image` with `srcLight` and `srcDark`. |
|
|
@@ -497,16 +500,10 @@ For a base-path application whose root page is documentation, add `"/"` to the s
|
|
|
497
500
|
Stable Geistdocs uses Tailwind CSS v4 with source entries for package components and related dependencies:
|
|
498
501
|
|
|
499
502
|
```css title="app/styles/geistdocs.css"
|
|
500
|
-
@import "
|
|
501
|
-
@import "fumadocs-ui/css/shadcn.css";
|
|
502
|
-
@import "fumadocs-ui/css/preset.css";
|
|
503
|
-
@import "tw-animate-css";
|
|
504
|
-
|
|
505
|
-
@source "../../node_modules/@vercel/geistdocs/dist/**/*.js";
|
|
506
|
-
@source "../../node_modules/streamdown/dist/*.js";
|
|
503
|
+
@import "@vercel/geistdocs/styles.css";
|
|
507
504
|
```
|
|
508
505
|
|
|
509
|
-
|
|
506
|
+
The package stylesheet owns the provider foundation, Geist tokens, typography, Fumadocs integration, and compiled runtime source discovery.
|
|
510
507
|
|
|
511
508
|
### Configure Tailwind CSS for the Geistcn canary
|
|
512
509
|
|
|
@@ -514,7 +511,6 @@ For the Geistcn canary, use the import order and narrow Geistcn source scan from
|
|
|
514
511
|
|
|
515
512
|
```css title="app/styles/geistdocs.css"
|
|
516
513
|
@import "@vercel/geistcn/tailwind.css";
|
|
517
|
-
@import "fumadocs-ui/css/shadcn.css";
|
|
518
514
|
@import "fumadocs-ui/css/preset.css";
|
|
519
515
|
@import "@vercel/geistdocs/theme.css";
|
|
520
516
|
@import "@vercel/geistcn/styles.css";
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Choose a Geistdocs package
|
|
3
|
+
description: Choose between the public Geistdocs package and Vercel's private Geistcn-backed package
|
|
4
|
+
type: guide
|
|
5
|
+
summary: Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.
|
|
6
|
+
url: /docs/packages
|
|
7
|
+
source: apps/template/content/docs/packages.mdx
|
|
8
|
+
related:
|
|
9
|
+
- /docs/getting-started
|
|
10
|
+
- /docs/deployment
|
|
11
|
+
- /docs/migration
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Choose a Geistdocs package
|
|
15
|
+
|
|
16
|
+
Geistdocs ships as two packages built from the same runtime and template. They expose the same API and intentionally share the same visual design, layout, interactions, and product behavior. A site should look and work the same with either package; only the underlying primitive and asset provider differs.
|
|
17
|
+
|
|
18
|
+
> Note:
|
|
19
|
+
`@vercel/geistdocs-private` is private because it directly uses the restricted `@vercel/geistcn` component library and `@vercel/geistcn-assets`—not simply because a repository is owned by Vercel. Vercel-owned OSS repositories are public and must use `@vercel/geistdocs`. The restricted packages contain Vercel product UI primitives and assets that are not distributed for public use. Giving external contributors access would expose the building blocks needed to closely reproduce Vercel product interfaces. Do not publish, redistribute, or expose the package, its dependencies, registry credentials, or downloaded artifacts outside internal environments authorized to use them.
|
|
20
|
+
|
|
21
|
+
| Package | Access | UI provider | Recommended use |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
| `@vercel/geistdocs` | Public | Package-owned public primitives and vendored assets | Open-source repositories, external contributors, and all projects without private Vercel npm access |
|
|
24
|
+
| `@vercel/geistdocs-private` | Private; restricted access | Restricted `@vercel/geistcn` components and `@vercel/geistcn-assets`; requires authenticated access to Vercel's private npm registry | Internal environments such as `front`; never public repositories or projects requiring external contributor access |
|
|
25
|
+
|
|
26
|
+
## Use the public package by default
|
|
27
|
+
|
|
28
|
+
Create a public Geistdocs project with:
|
|
29
|
+
|
|
30
|
+
```bash title="Terminal"
|
|
31
|
+
pnpm dlx @vercel/geistdocs@latest init --name my-docs
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
The generated project has no dependency or peer dependency on `@vercel/geistcn` or `@vercel/geistcn-assets`. Contributors can install it using normal public npm access.
|
|
35
|
+
|
|
36
|
+
## Use the private package inside Vercel
|
|
37
|
+
|
|
38
|
+
Create the private variant with:
|
|
39
|
+
|
|
40
|
+
```bash title="Terminal"
|
|
41
|
+
pnpm dlx @vercel/geistdocs-private@latest init --name my-docs
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The private initializer asks whether the generated template will be used in a public repository. Answer **Yes** to generate the public `@vercel/geistdocs` variant without restricted dependencies. Answer **No** to keep `@vercel/geistdocs-private`.
|
|
45
|
+
|
|
46
|
+
The private package declares `@vercel/geistcn` and `@vercel/geistcn-assets` as peer dependencies. Both local development and deployment must be authenticated to Vercel's private npm registry. This makes it suitable only for internal environments such as `front`, where that access already exists and remains limited to authorized Vercel users.
|
|
47
|
+
|
|
48
|
+
Do not use the private package in a public repository or provide its registry access to external contributors. Use the public package whenever anyone outside Vercel needs to install, build, or contribute to the project—even if the site itself is deployed on Vercel.
|
|
49
|
+
|
|
50
|
+
## Keep package identities consistent
|
|
51
|
+
|
|
52
|
+
The CLI writes the package that initialized the project into every generated import and dependency. Keep one Geistdocs package throughout the app and update it with that package's CLI. Do not install both variants or combine imports from them.
|
|
53
|
+
|
|
54
|
+
Switching variants should require only changing package identity and provider-specific dependency metadata. Application content, configuration, route adapters, and Geistdocs APIs remain the same.
|
package/docs/pages/proxy.md
CHANGED
|
@@ -192,9 +192,15 @@ export const config = {
|
|
|
192
192
|
|
|
193
193
|
The package keeps `llms.txt`, `sitemap.md`, `agents.md`, MCP discovery, and RSS out of root page-Markdown negotiation. Continue to exclude site-specific application and API routes with the matcher or a `before` hook. A root Markdown page is exposed as `/index.md`, or `<basePath>/index.md` publicly.
|
|
194
194
|
|
|
195
|
+
## Negotiate HTML and Markdown
|
|
196
|
+
|
|
197
|
+
Explicit `Accept` preferences determine the response for extensionless mapped URLs. Geistdocs recognizes `text/markdown`, `text/x-markdown`, and `text/plain` as Markdown media types and compares their quality and specificity with HTML media types. An explicit HTML preference or Markdown with `q=0` continues to the app's normal HTML handling.
|
|
198
|
+
|
|
199
|
+
Agent detection acts as a fallback when `Accept` is missing or does not distinguish HTML from Markdown. Explicit `.md` and `.mdx` URLs always request Markdown, even when the client usually prefers HTML. Geistdocs does not return `406 Not Acceptable` when Markdown is not selected.
|
|
200
|
+
|
|
195
201
|
## Recover unmatched Markdown requests
|
|
196
202
|
|
|
197
|
-
`createGeistdocs` in `next.config.ts` generates a lightweight manifest from App Router pages and route handlers. When `agent` is enabled, `createProxy` uses this manifest to return a Markdown 404 only when
|
|
203
|
+
`createGeistdocs` in `next.config.ts` generates a lightweight manifest from App Router pages and route handlers. When `agent` is enabled, `createProxy` uses this manifest to return a Markdown 404 only when an eligible Markdown `GET` or `HEAD` request matches neither a Markdown mapping nor an application route. Requests that prefer HTML keep the app's normal HTML recovery, including requests from detected agents.
|
|
198
204
|
|
|
199
205
|
The manifest contains route patterns, not page modules or content. Static, dynamic, catch-all, optional catch-all, grouped, and localized routes continue to Next.js. Root catch-all pages are treated as potentially valid, so the app remains responsible for their 404 behavior. The package's own `[...not-found]` route handler is excluded so it does not claim every path.
|
|
200
206
|
|