@vercel/geistdocs 1.28.1 → 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/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/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/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 +512 -138
- 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 +24 -5
- package/docs/pages/migration.md +11 -15
- package/docs/pages/packages.md +54 -0
- 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 +24 -5
- 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/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/pages/syntax.md
CHANGED
|
@@ -15,7 +15,9 @@ related:
|
|
|
15
15
|
|
|
16
16
|
Geistdocs supports MDX, a superset of Markdown that allows you to use JSX components within your documentation. This guide covers all the formatting options available.
|
|
17
17
|
|
|
18
|
-
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
18
|
+
Help me write a Geistdocs MDX page. Use this page as a syntax reference and
|
|
19
|
+
create an example page with frontmatter, headings, links, a code block, a
|
|
20
|
+
`Callout`, and a `CopyPrompt` component.
|
|
19
21
|
|
|
20
22
|
## Frontmatter
|
|
21
23
|
|
|
@@ -67,11 +69,17 @@ Headings automatically generate anchor links for navigation and deep linking.
|
|
|
67
69
|
|
|
68
70
|
Create unordered lists with `-`, `*`, or `+`:
|
|
69
71
|
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
72
|
+
```md
|
|
73
|
+
- Install the required packages
|
|
74
|
+
- Configure your project
|
|
75
|
+
- Start the development server
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
This renders as:
|
|
79
|
+
|
|
80
|
+
- Install the required packages
|
|
81
|
+
- Configure your project
|
|
82
|
+
- Start the development server
|
|
75
83
|
|
|
76
84
|
Create ordered lists with numbers:
|
|
77
85
|
|
|
@@ -79,11 +87,99 @@ Create ordered lists with numbers:
|
|
|
79
87
|
2. Second step
|
|
80
88
|
3. Third step
|
|
81
89
|
|
|
90
|
+
### Steps
|
|
91
|
+
|
|
92
|
+
Headings that start with a number, such as `### 1. Install the CLI`, render as a numbered step list with a counter beside each heading. See [Steps](/docs/components/steps) for the grouping rules and the `Steps` and `Step` components.
|
|
93
|
+
|
|
82
94
|
### Blockquotes
|
|
83
95
|
|
|
84
96
|
Use `>` to create blockquotes:
|
|
85
97
|
|
|
86
|
-
>
|
|
98
|
+
> **Watch:** Learn more about how to use `next/image` → [YouTube (9 minutes)](https://youtu.be/IU_qq_c_lKA).
|
|
99
|
+
|
|
100
|
+
### Callouts
|
|
101
|
+
|
|
102
|
+
Use `<Callout>` for a highlighted informational note:
|
|
103
|
+
|
|
104
|
+
```mdx
|
|
105
|
+
<Callout>This is automatically set when deploying to Vercel.</Callout>
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
This renders as:
|
|
109
|
+
|
|
110
|
+
> This is automatically set when deploying to Vercel.
|
|
111
|
+
|
|
112
|
+
Callouts can also contain a title and lists:
|
|
113
|
+
|
|
114
|
+
> Note:
|
|
115
|
+
- The `App Router` uses [React canary
|
|
116
|
+
releases](https://react.dev/blog/2023/05/03/react-canaries) built-in, which
|
|
117
|
+
include all the stable React 19 changes, as well as newer features being
|
|
118
|
+
validated in frameworks, but you should still declare react and react-dom in
|
|
119
|
+
package.json for tooling and ecosystem compatibility.
|
|
120
|
+
- The `Pages Router` uses the React version from your `package.json`.
|
|
121
|
+
|
|
122
|
+
Callouts support rich inline Markdown, including code, emphasis, and links:
|
|
123
|
+
|
|
124
|
+
```mdx
|
|
125
|
+
<Callout title="Good to know">
|
|
126
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
127
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
128
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
129
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
130
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
131
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
132
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
133
|
+
custom scoped CSS when needed.
|
|
134
|
+
</Callout>
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
This renders as:
|
|
138
|
+
|
|
139
|
+
> Note:
|
|
140
|
+
Global styles can be imported into any layout, page, or component inside the
|
|
141
|
+
`app` directory. However, since Next.js uses React's built-in support for
|
|
142
|
+
stylesheets to integrate with Suspense, this currently does not remove
|
|
143
|
+
stylesheets as you navigate between routes which can lead to conflicts. We
|
|
144
|
+
recommend using global styles for _truly global_ CSS (like Tailwind's base
|
|
145
|
+
styles), [Tailwind CSS](https://tailwindcss.com) for component styling, and
|
|
146
|
+
[CSS Modules](https://nextjs.org/docs/app/getting-started/css#css-modules) for
|
|
147
|
+
custom scoped CSS when needed.
|
|
148
|
+
|
|
149
|
+
### Copy Prompts
|
|
150
|
+
|
|
151
|
+
Short prompts render in full without an expansion control:
|
|
152
|
+
|
|
153
|
+
```mdx
|
|
154
|
+
<CopyPrompt text="Summarize this documentation page and list the key concepts.">
|
|
155
|
+
Summarize this documentation page and list the key concepts.
|
|
156
|
+
</CopyPrompt>
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
This renders as:
|
|
160
|
+
|
|
161
|
+
Summarize this documentation page and list the key concepts.
|
|
162
|
+
|
|
163
|
+
Long prompts initially show a preview with a **Show more** control:
|
|
164
|
+
|
|
165
|
+
```mdx
|
|
166
|
+
<CopyPrompt collapsible text="Write a detailed migration plan for this project.">
|
|
167
|
+
Write a detailed migration plan for this project. Include prerequisites,
|
|
168
|
+
implementation steps, validation, rollback guidance, and common pitfalls.
|
|
169
|
+
</CopyPrompt>
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Set the boolean `collapsible` prop when the prompt should initially render as a
|
|
173
|
+
two-line preview. This renders as:
|
|
174
|
+
|
|
175
|
+
Review this Geistdocs project in detail. Explain how the `@vercel/geistdocs`
|
|
176
|
+
package, application layouts, local adapter files, source configuration,
|
|
177
|
+
`content/docs` directory, navigation metadata, MDX components, syntax
|
|
178
|
+
highlighting, search routes, and deployment configuration work together.
|
|
179
|
+
Then identify the safest first files to edit, describe the effect of each
|
|
180
|
+
change, call out common mistakes, and propose a step-by-step plan for
|
|
181
|
+
customizing the documentation site without breaking routing, generated
|
|
182
|
+
Markdown, or accessibility behavior.
|
|
87
183
|
|
|
88
184
|
### Links
|
|
89
185
|
|
|
@@ -92,6 +188,25 @@ Create links with `[text](url)`:
|
|
|
92
188
|
- [External link](https://vercel.com)
|
|
93
189
|
- [Internal link](/docs/getting-started)
|
|
94
190
|
|
|
191
|
+
Use an absolute `https://` or `http://` URL for an external destination. Use a
|
|
192
|
+
root-relative path beginning with `/` for an internal link. Both use the same
|
|
193
|
+
visual styling:
|
|
194
|
+
|
|
195
|
+
```md
|
|
196
|
+
[External link](https://vercel.com)
|
|
197
|
+
[Internal link](/docs/getting-started)
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
Links can also contain inline code:
|
|
201
|
+
|
|
202
|
+
```md
|
|
203
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
This renders as:
|
|
207
|
+
|
|
208
|
+
Run independent requests in parallel with [`Promise.all`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise/all).
|
|
209
|
+
|
|
95
210
|
### Images
|
|
96
211
|
|
|
97
212
|
Add images with ``:
|
|
@@ -100,6 +215,44 @@ Add images with ``:
|
|
|
100
215
|

|
|
101
216
|
```
|
|
102
217
|
|
|
218
|
+
Use `<Image>` when an image needs the standard documentation presentation and
|
|
219
|
+
an optional description. It uses Geistcn's image component without a lightbox
|
|
220
|
+
or other interaction:
|
|
221
|
+
|
|
222
|
+
```mdx
|
|
223
|
+
<Image
|
|
224
|
+
alt="Deployment graph"
|
|
225
|
+
caption="Requests move from the edge to the selected region."
|
|
226
|
+
height={480}
|
|
227
|
+
src="/deployment-graph.png"
|
|
228
|
+
width={800}
|
|
229
|
+
/>
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
This renders as:
|
|
233
|
+
|
|
234
|
+
<Image
|
|
235
|
+
alt="Navigation Inspector showing a loading shell for a page load"
|
|
236
|
+
caption="The Navigation Inspector paused on a page load."
|
|
237
|
+
height={389}
|
|
238
|
+
srcDark="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/dark/inspector-load.png"
|
|
239
|
+
srcLight="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/light/inspector-load.png"
|
|
240
|
+
width={472}
|
|
241
|
+
/>
|
|
242
|
+
|
|
243
|
+
For theme-aware images, provide both sources:
|
|
244
|
+
|
|
245
|
+
```mdx
|
|
246
|
+
<Image
|
|
247
|
+
alt="Deployment graph"
|
|
248
|
+
caption="Requests move from the edge to the selected region."
|
|
249
|
+
height={480}
|
|
250
|
+
srcDark="/deployment-graph-dark.png"
|
|
251
|
+
srcLight="/deployment-graph-light.png"
|
|
252
|
+
width={800}
|
|
253
|
+
/>
|
|
254
|
+
```
|
|
255
|
+
|
|
103
256
|
## GitHub Flavored Markdown
|
|
104
257
|
|
|
105
258
|
Geistdocs supports GFM extensions including tables, task lists, and autolinks.
|
|
@@ -124,6 +277,16 @@ This renders as:
|
|
|
124
277
|
| GFM | GitHub extensions | Supported |
|
|
125
278
|
| MDX | JSX in Markdown | Supported |
|
|
126
279
|
|
|
280
|
+
Tables can also include inline code, as commonly used for file references:
|
|
281
|
+
|
|
282
|
+
| File | Description |
|
|
283
|
+
| -------------------- | ------------------------------------------------ |
|
|
284
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
285
|
+
| `package.json` | Project dependencies and scripts |
|
|
286
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
287
|
+
| `.env.local` | Local environment variables |
|
|
288
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
289
|
+
|
|
127
290
|
### Task Lists
|
|
128
291
|
|
|
129
292
|
Create interactive task lists:
|
|
@@ -196,6 +359,78 @@ export const Button = ({ children }) => {
|
|
|
196
359
|
};
|
|
197
360
|
```
|
|
198
361
|
|
|
362
|
+
### Tabs and switchers
|
|
363
|
+
|
|
364
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
365
|
+
option at once:
|
|
366
|
+
|
|
367
|
+
````md
|
|
368
|
+
```ts tab="TypeScript" title="example.ts"
|
|
369
|
+
export const greeting: string = "Hello from TypeScript";
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
```js tab="JavaScript" title="example.js"
|
|
373
|
+
export const greeting = "Hello from JavaScript";
|
|
374
|
+
```
|
|
375
|
+
````
|
|
376
|
+
|
|
377
|
+
This renders as:
|
|
378
|
+
|
|
379
|
+
```ts tab="TypeScript" title="example.ts"
|
|
380
|
+
export const greeting: string = "Hello from TypeScript";
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
```js tab="JavaScript" title="example.js"
|
|
384
|
+
export const greeting = "Hello from JavaScript";
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
388
|
+
code-block header:
|
|
389
|
+
|
|
390
|
+
````mdx
|
|
391
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
392
|
+
<CodeBlockTabsList>
|
|
393
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
394
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
395
|
+
</CodeBlockTabsList>
|
|
396
|
+
<CodeBlockTab value="TypeScript">
|
|
397
|
+
```ts title="example.ts"
|
|
398
|
+
export const greeting: string = "Hello from TypeScript";
|
|
399
|
+
```
|
|
400
|
+
</CodeBlockTab>
|
|
401
|
+
<CodeBlockTab value="JavaScript">
|
|
402
|
+
```js title="example.js"
|
|
403
|
+
export const greeting = "Hello from JavaScript";
|
|
404
|
+
```
|
|
405
|
+
</CodeBlockTab>
|
|
406
|
+
</CompactCodeBlockTabs>
|
|
407
|
+
````
|
|
408
|
+
|
|
409
|
+
This renders as:
|
|
410
|
+
|
|
411
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
412
|
+
<CodeBlockTabsList>
|
|
413
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
414
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
415
|
+
</CodeBlockTabsList>
|
|
416
|
+
<CodeBlockTab value="TypeScript">
|
|
417
|
+
```ts title="example.ts"
|
|
418
|
+
export const greeting: string = "Hello from TypeScript";
|
|
419
|
+
```
|
|
420
|
+
</CodeBlockTab>
|
|
421
|
+
<CodeBlockTab value="JavaScript">
|
|
422
|
+
```js title="example.js"
|
|
423
|
+
export const greeting = "Hello from JavaScript";
|
|
424
|
+
```
|
|
425
|
+
</CodeBlockTab>
|
|
426
|
+
</CompactCodeBlockTabs>
|
|
427
|
+
|
|
428
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
429
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
430
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
431
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
432
|
+
package's compiled components and emits the tab layout utilities.
|
|
433
|
+
|
|
199
434
|
### Framework icons
|
|
200
435
|
|
|
201
436
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -204,22 +439,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
204
439
|
|
|
205
440
|
````md
|
|
206
441
|
```ts title="flags.ts#next"
|
|
207
|
-
import { flag } from
|
|
442
|
+
import { flag } from "flags/next";
|
|
208
443
|
```
|
|
209
444
|
|
|
210
445
|
```ts title="flags.ts#svelte"
|
|
211
|
-
import { flag } from
|
|
446
|
+
import { flag } from "flags/sveltekit";
|
|
212
447
|
```
|
|
213
448
|
````
|
|
214
449
|
|
|
215
450
|
This renders as:
|
|
216
451
|
|
|
217
452
|
```ts title="flags.ts#next"
|
|
218
|
-
import { flag } from
|
|
453
|
+
import { flag } from "flags/next";
|
|
219
454
|
```
|
|
220
455
|
|
|
221
456
|
```ts title="flags.ts#svelte"
|
|
222
|
-
import { flag } from
|
|
457
|
+
import { flag } from "flags/sveltekit";
|
|
223
458
|
```
|
|
224
459
|
|
|
225
460
|
### Line Numbers
|
|
@@ -181,7 +181,6 @@ Each version can define an `icon` to override the default current/previous versi
|
|
|
181
181
|
Use `GeistdocsRouteSelect` for framework, product, or route switchers that should not use version-specific labels:
|
|
182
182
|
|
|
183
183
|
```tsx
|
|
184
|
-
import { LogoNextjs, LogoSvelteKit } from "@vercel/geistdocs/assets/logos";
|
|
185
184
|
import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
186
185
|
|
|
187
186
|
<GeistdocsRouteSelect
|
|
@@ -192,14 +191,14 @@ import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
|
192
191
|
id: "nextjs",
|
|
193
192
|
label: "Next.js",
|
|
194
193
|
description: "React framework",
|
|
195
|
-
icon: <
|
|
194
|
+
icon: <span aria-hidden>N</span>,
|
|
196
195
|
href: "/:path*",
|
|
197
196
|
},
|
|
198
197
|
{
|
|
199
198
|
id: "sveltekit",
|
|
200
199
|
label: "SvelteKit",
|
|
201
200
|
description: "Svelte framework",
|
|
202
|
-
icon: <
|
|
201
|
+
icon: <span aria-hidden>S</span>,
|
|
203
202
|
routePrefix: "/sveltekit",
|
|
204
203
|
href: "/sveltekit/:path*",
|
|
205
204
|
},
|
package/docs/sitemap.md
CHANGED
|
@@ -6,8 +6,9 @@ Use it to choose focused page files from `docs/pages/` before reading the full `
|
|
|
6
6
|
- [Overview](pages/index.md) | URL: /docs | Type: overview | Summary: Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features.
|
|
7
7
|
- [Getting Started](pages/getting-started.md) | URL: /docs/getting-started | Type: guide | Summary: Create a Geistdocs project, run it locally, and edit your first documentation page.
|
|
8
8
|
- [Environment Variables](pages/env.md) | URL: /docs/env | Type: reference | Summary: Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, and production URL configuration.
|
|
9
|
-
- [Deploy to Vercel](pages/deployment.md) | URL: /docs/deployment | Type: guide | Summary: Deploy a Geistdocs site to Vercel with the required project settings
|
|
10
|
-
- [
|
|
9
|
+
- [Deploy to Vercel](pages/deployment.md) | URL: /docs/deployment | Type: guide | Summary: Deploy a Geistdocs site to Vercel with the required project settings and environment variables.
|
|
10
|
+
- [Migrate to Geistdocs](pages/migration.md) | URL: /docs/migration | Type: guide | Summary: Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
11
|
+
- [Choose a Geistdocs package](pages/packages.md) | URL: /docs/packages | Type: guide | Summary: Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.
|
|
11
12
|
- [Configuration](pages/configuration.md) | URL: /docs/configuration | Type: reference | Summary: Configure site metadata, navigation, AI features, page actions, translations, and local adapters.
|
|
12
13
|
- [Syntax](pages/syntax.md) | URL: /docs/syntax | Type: reference | Summary: Supported MDX syntax including text formatting, code blocks, line highlighting, and Mermaid diagrams.
|
|
13
14
|
- [Geistdocs Provider](pages/provider.md) | URL: /docs/provider | Type: reference | Summary: The root provider component that wraps your application to handle toast notifications, search, and analytics.
|
|
@@ -25,6 +26,6 @@ Use it to choose focused page files from `docs/pages/` before reading the full `
|
|
|
25
26
|
- [llms.txt](pages/llms-txt.md) | URL: /docs/llms-txt | Type: conceptual | Summary: A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
|
|
26
27
|
- [Open in Chat](pages/open-in-chat.md) | URL: /docs/open-in-chat | Type: conceptual | Summary: Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click.
|
|
27
28
|
- [RSS](pages/rss.md) | URL: /docs/rss | Type: conceptual | Summary: An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated.
|
|
29
|
+
- [Steps](pages/components/steps.md) | URL: /docs/components/steps | Type: reference | 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.
|
|
28
30
|
- [Table of contents](pages/table-of-contents.md) | URL: /docs/table-of-contents | Type: reference | Summary: Geistdocs builds the "On this page" outline from your headings, indents sub-headings under their parent, and tracks the active section along a straight vertical guide rail.
|
|
29
|
-
- [Theme-Aware Image](pages/theme-aware-image.md) | URL: /docs/theme-aware-image | Type: reference | Summary: A component that swaps images based on the active theme, built on top of Next.js Image.
|
|
30
31
|
- [WebMCP](pages/webmcp.md) | URL: /docs/webmcp
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vercel/geistdocs",
|
|
3
3
|
"description": "Runtime and CLI for Geistdocs projects.",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "2.0.0",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -9,6 +9,10 @@
|
|
|
9
9
|
"directory": "packages/geistdocs"
|
|
10
10
|
},
|
|
11
11
|
"type": "module",
|
|
12
|
+
"imports": {
|
|
13
|
+
"#geistdocs-assets/*": "./dist/providers/public-assets/*.js",
|
|
14
|
+
"#geistdocs-ui/*": "./dist/providers/public/*.js"
|
|
15
|
+
},
|
|
12
16
|
"bin": {
|
|
13
17
|
"geistdocs": "cli.js"
|
|
14
18
|
},
|
|
@@ -22,6 +26,8 @@
|
|
|
22
26
|
"docs",
|
|
23
27
|
"source-config.js",
|
|
24
28
|
"template",
|
|
29
|
+
"public-foundation.css",
|
|
30
|
+
"shared-theme.css",
|
|
25
31
|
"styles.css",
|
|
26
32
|
"theme.css",
|
|
27
33
|
"LICENSE"
|
|
@@ -135,6 +141,14 @@
|
|
|
135
141
|
"types": "./dist/mdx.d.ts",
|
|
136
142
|
"default": "./dist/mdx.js"
|
|
137
143
|
},
|
|
144
|
+
"./core": {
|
|
145
|
+
"types": "./dist/providers/public/core.d.ts",
|
|
146
|
+
"default": "./dist/providers/public/core.js"
|
|
147
|
+
},
|
|
148
|
+
"./utils": {
|
|
149
|
+
"types": "./dist/providers/public/utils.d.ts",
|
|
150
|
+
"default": "./dist/providers/public/utils.js"
|
|
151
|
+
},
|
|
138
152
|
"./source-config": {
|
|
139
153
|
"types": "./dist/source-config.d.ts",
|
|
140
154
|
"default": "./source-config.js"
|
|
@@ -148,25 +162,21 @@
|
|
|
148
162
|
"types": "./dist/shiki-theme.d.ts",
|
|
149
163
|
"default": "./dist/shiki-theme.js"
|
|
150
164
|
},
|
|
151
|
-
"./components/badge": {
|
|
152
|
-
"types": "./dist/components/badge.d.ts",
|
|
153
|
-
"default": "./dist/components/badge.js"
|
|
154
|
-
},
|
|
155
|
-
"./components/button": {
|
|
156
|
-
"types": "./dist/components/button.d.ts",
|
|
157
|
-
"default": "./dist/components/button.js"
|
|
158
|
-
},
|
|
159
|
-
"./components/button-group": {
|
|
160
|
-
"types": "./dist/components/button-group.d.ts",
|
|
161
|
-
"default": "./dist/components/button-group.js"
|
|
162
|
-
},
|
|
163
165
|
"./components/callout": {
|
|
164
166
|
"types": "./dist/components/callout.d.ts",
|
|
165
167
|
"default": "./dist/components/callout.js"
|
|
166
168
|
},
|
|
167
|
-
"./components/
|
|
168
|
-
"types": "./dist/components/
|
|
169
|
-
"default": "./dist/components/
|
|
169
|
+
"./components/badge": {
|
|
170
|
+
"types": "./dist/providers/public/components/badge.d.ts",
|
|
171
|
+
"default": "./dist/providers/public/components/badge.js"
|
|
172
|
+
},
|
|
173
|
+
"./components/button": {
|
|
174
|
+
"types": "./dist/providers/public/components/button.d.ts",
|
|
175
|
+
"default": "./dist/providers/public/components/button.js"
|
|
176
|
+
},
|
|
177
|
+
"./components/theme-switcher": {
|
|
178
|
+
"types": "./dist/providers/public/components/theme-switcher.d.ts",
|
|
179
|
+
"default": "./dist/providers/public/components/theme-switcher.js"
|
|
170
180
|
},
|
|
171
181
|
"./components/code-block": {
|
|
172
182
|
"types": "./dist/components/code-block.d.ts",
|
|
@@ -188,34 +198,14 @@
|
|
|
188
198
|
"types": "./dist/components/copy-prompt.d.ts",
|
|
189
199
|
"default": "./dist/components/copy-prompt.js"
|
|
190
200
|
},
|
|
191
|
-
"./components/
|
|
192
|
-
"types": "./dist/components/
|
|
193
|
-
"default": "./dist/components/
|
|
194
|
-
},
|
|
195
|
-
"./components/drawer": {
|
|
196
|
-
"types": "./dist/components/drawer.d.ts",
|
|
197
|
-
"default": "./dist/components/drawer.js"
|
|
201
|
+
"./components/image": {
|
|
202
|
+
"types": "./dist/components/image.d.ts",
|
|
203
|
+
"default": "./dist/components/image.js"
|
|
198
204
|
},
|
|
199
205
|
"./components/dropdown-menu": {
|
|
200
206
|
"types": "./dist/components/dropdown-menu.d.ts",
|
|
201
207
|
"default": "./dist/components/dropdown-menu.js"
|
|
202
208
|
},
|
|
203
|
-
"./components/input": {
|
|
204
|
-
"types": "./dist/components/input.d.ts",
|
|
205
|
-
"default": "./dist/components/input.js"
|
|
206
|
-
},
|
|
207
|
-
"./components/input-group": {
|
|
208
|
-
"types": "./dist/components/input-group.d.ts",
|
|
209
|
-
"default": "./dist/components/input-group.js"
|
|
210
|
-
},
|
|
211
|
-
"./components/kbd": {
|
|
212
|
-
"types": "./dist/components/kbd.d.ts",
|
|
213
|
-
"default": "./dist/components/kbd.js"
|
|
214
|
-
},
|
|
215
|
-
"./components/theme-aware-image": {
|
|
216
|
-
"types": "./dist/components/theme-aware-image.d.ts",
|
|
217
|
-
"default": "./dist/components/theme-aware-image.js"
|
|
218
|
-
},
|
|
219
209
|
"./components/mermaid": {
|
|
220
210
|
"types": "./dist/components/mermaid.d.ts",
|
|
221
211
|
"default": "./dist/components/mermaid.js"
|
|
@@ -232,58 +222,14 @@
|
|
|
232
222
|
"types": "./dist/components/scroll-area.d.ts",
|
|
233
223
|
"default": "./dist/components/scroll-area.js"
|
|
234
224
|
},
|
|
235
|
-
"./components/
|
|
236
|
-
"types": "./dist/components/
|
|
237
|
-
"default": "./dist/components/
|
|
238
|
-
},
|
|
239
|
-
"./components/sheet": {
|
|
240
|
-
"types": "./dist/components/sheet.d.ts",
|
|
241
|
-
"default": "./dist/components/sheet.js"
|
|
242
|
-
},
|
|
243
|
-
"./components/sonner": {
|
|
244
|
-
"types": "./dist/components/sonner.d.ts",
|
|
245
|
-
"default": "./dist/components/sonner.js"
|
|
246
|
-
},
|
|
247
|
-
"./components/spinner": {
|
|
248
|
-
"types": "./dist/components/spinner.d.ts",
|
|
249
|
-
"default": "./dist/components/spinner.js"
|
|
250
|
-
},
|
|
251
|
-
"./components/switch": {
|
|
252
|
-
"types": "./dist/components/switch.d.ts",
|
|
253
|
-
"default": "./dist/components/switch.js"
|
|
254
|
-
},
|
|
255
|
-
"./components/theme-switcher": {
|
|
256
|
-
"types": "./dist/components/theme-switcher.d.ts",
|
|
257
|
-
"default": "./dist/components/theme-switcher.js"
|
|
258
|
-
},
|
|
259
|
-
"./components/textarea": {
|
|
260
|
-
"types": "./dist/components/textarea.d.ts",
|
|
261
|
-
"default": "./dist/components/textarea.js"
|
|
262
|
-
},
|
|
263
|
-
"./components/tooltip": {
|
|
264
|
-
"types": "./dist/components/tooltip.d.ts",
|
|
265
|
-
"default": "./dist/components/tooltip.js"
|
|
225
|
+
"./components/steps": {
|
|
226
|
+
"types": "./dist/components/steps.d.ts",
|
|
227
|
+
"default": "./dist/components/steps.js"
|
|
266
228
|
},
|
|
267
229
|
"./components/video": {
|
|
268
230
|
"types": "./dist/components/video.d.ts",
|
|
269
231
|
"default": "./dist/components/video.js"
|
|
270
232
|
},
|
|
271
|
-
"./assets/icons": {
|
|
272
|
-
"types": "./dist/assets/icons/index.d.ts",
|
|
273
|
-
"default": "./dist/assets/icons/index.js"
|
|
274
|
-
},
|
|
275
|
-
"./assets/icons/*": {
|
|
276
|
-
"types": "./dist/assets/icons/*.d.ts",
|
|
277
|
-
"default": "./dist/assets/icons/*.js"
|
|
278
|
-
},
|
|
279
|
-
"./assets/logos": {
|
|
280
|
-
"types": "./dist/assets/logos/index.d.ts",
|
|
281
|
-
"default": "./dist/assets/logos/index.js"
|
|
282
|
-
},
|
|
283
|
-
"./assets/logos/*": {
|
|
284
|
-
"types": "./dist/assets/logos/*.d.ts",
|
|
285
|
-
"default": "./dist/assets/logos/*.js"
|
|
286
|
-
},
|
|
287
233
|
"./styles.css": "./styles.css",
|
|
288
234
|
"./theme.css": "./theme.css",
|
|
289
235
|
"./package.json": "./package.json"
|
|
@@ -291,11 +237,9 @@
|
|
|
291
237
|
"dependencies": {
|
|
292
238
|
"@ai-sdk/react": "^3.0.134",
|
|
293
239
|
"@clack/prompts": "^0.11.0",
|
|
294
|
-
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
295
240
|
"@next/env": "16.3.3",
|
|
296
241
|
"@orama/tokenizers": "^3.1.16",
|
|
297
242
|
"@streamdown/cjk": "^1.0.1",
|
|
298
|
-
"@streamdown/code": "^1.0.1",
|
|
299
243
|
"@types/mdx": "^2.0.13",
|
|
300
244
|
"@types/react": "^19.2.7",
|
|
301
245
|
"@vercel/agent-readability": "^0.7.0",
|
|
@@ -309,11 +253,12 @@
|
|
|
309
253
|
"fumadocs-core": "16.2.2",
|
|
310
254
|
"fumadocs-mdx": "14.0.4",
|
|
311
255
|
"fumadocs-ui": "16.2.2",
|
|
256
|
+
"geist": "1.7.1",
|
|
312
257
|
"glob": "^11.0.0",
|
|
313
|
-
"lucide-react": "^0.555.0",
|
|
314
258
|
"mermaid": "^11.12.2",
|
|
315
259
|
"motion": "^12.23.25",
|
|
316
260
|
"next-themes": "^0.4.6",
|
|
261
|
+
"phase": "^0.5.4",
|
|
317
262
|
"radix-ui": "1.6.4",
|
|
318
263
|
"react-markdown": "^10.1.0",
|
|
319
264
|
"react-player": "^3.4.0",
|
|
@@ -321,10 +266,11 @@
|
|
|
321
266
|
"remark-gfm": "^4.0.1",
|
|
322
267
|
"remark-mdx": "^3.1.1",
|
|
323
268
|
"remark-parse": "^11.0.0",
|
|
269
|
+
"remark-stringify": "^11.0.0",
|
|
324
270
|
"sonner": "^2.0.7",
|
|
325
271
|
"streamdown": "^2.1.0",
|
|
326
|
-
"tailwind-merge": "^3.4.0",
|
|
327
272
|
"ts-morph": "^27.0.2",
|
|
273
|
+
"tailwind-merge": "^3.4.0",
|
|
328
274
|
"tw-animate-css": "^1.4.0",
|
|
329
275
|
"unified": "^11.0.5",
|
|
330
276
|
"unist-util-visit": "^5.1.0",
|