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

|
|
99
220
|
```
|
|
100
221
|
|
|
222
|
+
Use `<Image>` when an image needs the standard documentation presentation and
|
|
223
|
+
an optional description. It uses Geistcn's image component without a lightbox
|
|
224
|
+
or other interaction:
|
|
225
|
+
|
|
226
|
+
```mdx
|
|
227
|
+
<Image
|
|
228
|
+
alt="Deployment graph"
|
|
229
|
+
caption="Requests move from the edge to the selected region."
|
|
230
|
+
height={480}
|
|
231
|
+
src="/deployment-graph.png"
|
|
232
|
+
width={800}
|
|
233
|
+
/>
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
This renders as:
|
|
237
|
+
|
|
238
|
+
<Image
|
|
239
|
+
alt="Navigation Inspector showing a loading shell for a page load"
|
|
240
|
+
caption="The Navigation Inspector paused on a page load."
|
|
241
|
+
height={389}
|
|
242
|
+
srcDark="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/dark/inspector-load.png"
|
|
243
|
+
srcLight="https://h8DxKfmAPhn8O0p3.public.blob.vercel-storage.com/docs/light/inspector-load.png"
|
|
244
|
+
width={472}
|
|
245
|
+
/>
|
|
246
|
+
|
|
247
|
+
For theme-aware images, provide both sources:
|
|
248
|
+
|
|
249
|
+
```mdx
|
|
250
|
+
<Image
|
|
251
|
+
alt="Deployment graph"
|
|
252
|
+
caption="Requests move from the edge to the selected region."
|
|
253
|
+
height={480}
|
|
254
|
+
srcDark="/deployment-graph-dark.png"
|
|
255
|
+
srcLight="/deployment-graph-light.png"
|
|
256
|
+
width={800}
|
|
257
|
+
/>
|
|
258
|
+
```
|
|
259
|
+
|
|
101
260
|
## GitHub Flavored Markdown
|
|
102
261
|
|
|
103
262
|
Geistdocs supports GFM extensions including tables, task lists, and autolinks.
|
|
@@ -122,6 +281,16 @@ This renders as:
|
|
|
122
281
|
| GFM | GitHub extensions | Supported |
|
|
123
282
|
| MDX | JSX in Markdown | Supported |
|
|
124
283
|
|
|
284
|
+
Tables can also include inline code, as commonly used for file references:
|
|
285
|
+
|
|
286
|
+
| File | Description |
|
|
287
|
+
| -------------------- | ------------------------------------------------ |
|
|
288
|
+
| `next.config.js` | Configuration file for Next.js |
|
|
289
|
+
| `package.json` | Project dependencies and scripts |
|
|
290
|
+
| `instrumentation.ts` | OpenTelemetry and instrumentation file |
|
|
291
|
+
| `.env.local` | Local environment variables |
|
|
292
|
+
| `tsconfig.json` | Configuration file for TypeScript |
|
|
293
|
+
|
|
125
294
|
### Task Lists
|
|
126
295
|
|
|
127
296
|
Create interactive task lists:
|
|
@@ -194,6 +363,78 @@ export const Button = ({ children }) => {
|
|
|
194
363
|
};
|
|
195
364
|
```
|
|
196
365
|
|
|
366
|
+
### Tabs and switchers
|
|
367
|
+
|
|
368
|
+
Use consecutive fences with `tab` metadata for code tabs that expose every
|
|
369
|
+
option at once:
|
|
370
|
+
|
|
371
|
+
````md
|
|
372
|
+
```ts tab="TypeScript" title="example.ts"
|
|
373
|
+
export const greeting: string = "Hello from TypeScript";
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
```js tab="JavaScript" title="example.js"
|
|
377
|
+
export const greeting = "Hello from JavaScript";
|
|
378
|
+
```
|
|
379
|
+
````
|
|
380
|
+
|
|
381
|
+
This renders as:
|
|
382
|
+
|
|
383
|
+
```ts tab="TypeScript" title="example.ts"
|
|
384
|
+
export const greeting: string = "Hello from TypeScript";
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
```js tab="JavaScript" title="example.js"
|
|
388
|
+
export const greeting = "Hello from JavaScript";
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
Wrap the same fences in `<CodeBlockTabs compact>` to move the selector into the
|
|
392
|
+
code-block header:
|
|
393
|
+
|
|
394
|
+
````mdx
|
|
395
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
396
|
+
<CodeBlockTabsList>
|
|
397
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
398
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
399
|
+
</CodeBlockTabsList>
|
|
400
|
+
<CodeBlockTab value="TypeScript">
|
|
401
|
+
```ts title="example.ts"
|
|
402
|
+
export const greeting: string = "Hello from TypeScript";
|
|
403
|
+
```
|
|
404
|
+
</CodeBlockTab>
|
|
405
|
+
<CodeBlockTab value="JavaScript">
|
|
406
|
+
```js title="example.js"
|
|
407
|
+
export const greeting = "Hello from JavaScript";
|
|
408
|
+
```
|
|
409
|
+
</CodeBlockTab>
|
|
410
|
+
</CompactCodeBlockTabs>
|
|
411
|
+
````
|
|
412
|
+
|
|
413
|
+
This renders as:
|
|
414
|
+
|
|
415
|
+
<CompactCodeBlockTabs defaultValue="TypeScript">
|
|
416
|
+
<CodeBlockTabsList>
|
|
417
|
+
<CodeBlockTabsTrigger value="TypeScript">TypeScript</CodeBlockTabsTrigger>
|
|
418
|
+
<CodeBlockTabsTrigger value="JavaScript">JavaScript</CodeBlockTabsTrigger>
|
|
419
|
+
</CodeBlockTabsList>
|
|
420
|
+
<CodeBlockTab value="TypeScript">
|
|
421
|
+
```ts title="example.ts"
|
|
422
|
+
export const greeting: string = "Hello from TypeScript";
|
|
423
|
+
```
|
|
424
|
+
</CodeBlockTab>
|
|
425
|
+
<CodeBlockTab value="JavaScript">
|
|
426
|
+
```js title="example.js"
|
|
427
|
+
export const greeting = "Hello from JavaScript";
|
|
428
|
+
```
|
|
429
|
+
</CodeBlockTab>
|
|
430
|
+
</CompactCodeBlockTabs>
|
|
431
|
+
|
|
432
|
+
When migrating an existing site such as next-site, translate adjacent
|
|
433
|
+
`switcher` fences to `tab="TypeScript"` and `tab="JavaScript"`, then wrap the
|
|
434
|
+
pair with `<CodeBlockTabs compact>`. Import `@vercel/geistdocs/styles.css` (or
|
|
435
|
+
`theme.css` with the documented Geist dependencies) so Tailwind scans the
|
|
436
|
+
package's compiled components and emits the tab layout utilities.
|
|
437
|
+
|
|
197
438
|
### Framework icons
|
|
198
439
|
|
|
199
440
|
Append `#<framework>` to the title to show a framework logo instead of the
|
|
@@ -202,22 +443,22 @@ values are `#next` / `#nextjs` and `#svelte` / `#sveltekit`:
|
|
|
202
443
|
|
|
203
444
|
````md
|
|
204
445
|
```ts title="flags.ts#next"
|
|
205
|
-
import { flag } from
|
|
446
|
+
import { flag } from "flags/next";
|
|
206
447
|
```
|
|
207
448
|
|
|
208
449
|
```ts title="flags.ts#svelte"
|
|
209
|
-
import { flag } from
|
|
450
|
+
import { flag } from "flags/sveltekit";
|
|
210
451
|
```
|
|
211
452
|
````
|
|
212
453
|
|
|
213
454
|
This renders as:
|
|
214
455
|
|
|
215
456
|
```ts title="flags.ts#next"
|
|
216
|
-
import { flag } from
|
|
457
|
+
import { flag } from "flags/next";
|
|
217
458
|
```
|
|
218
459
|
|
|
219
460
|
```ts title="flags.ts#svelte"
|
|
220
|
-
import { flag } from
|
|
461
|
+
import { flag } from "flags/sveltekit";
|
|
221
462
|
```
|
|
222
463
|
|
|
223
464
|
### Line Numbers
|
|
@@ -179,7 +179,6 @@ Each version can define an `icon` to override the default current/previous versi
|
|
|
179
179
|
Use `GeistdocsRouteSelect` for framework, product, or route switchers that should not use version-specific labels:
|
|
180
180
|
|
|
181
181
|
```tsx
|
|
182
|
-
import { LogoNextjs, LogoSvelteKit } from "@vercel/geistdocs/assets/logos";
|
|
183
182
|
import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
184
183
|
|
|
185
184
|
<GeistdocsRouteSelect
|
|
@@ -190,14 +189,14 @@ import { GeistdocsRouteSelect } from "@vercel/geistdocs/versions";
|
|
|
190
189
|
id: "nextjs",
|
|
191
190
|
label: "Next.js",
|
|
192
191
|
description: "React framework",
|
|
193
|
-
icon: <
|
|
192
|
+
icon: <span aria-hidden>N</span>,
|
|
194
193
|
href: "/:path*",
|
|
195
194
|
},
|
|
196
195
|
{
|
|
197
196
|
id: "sveltekit",
|
|
198
197
|
label: "SvelteKit",
|
|
199
198
|
description: "Svelte framework",
|
|
200
|
-
icon: <
|
|
199
|
+
icon: <span aria-hidden>S</span>,
|
|
201
200
|
routePrefix: "/sveltekit",
|
|
202
201
|
href: "/sveltekit/:path*",
|
|
203
202
|
},
|
package/template/next.config.ts
CHANGED
|
@@ -13,7 +13,6 @@ const withGeistdocs = createGeistdocs();
|
|
|
13
13
|
const inMonorepo = existsSync(
|
|
14
14
|
join(process.cwd(), "../../packages/geistdocs/src")
|
|
15
15
|
);
|
|
16
|
-
|
|
17
16
|
// Distinct favicon per environment; production keeps the default (no-op).
|
|
18
17
|
const ENV_FAVICONS = {
|
|
19
18
|
development: "/favicon.development.ico",
|
|
@@ -24,6 +23,15 @@ const environment = process.env.VERCEL_ENV ?? process.env.NODE_ENV;
|
|
|
24
23
|
const envFavicon = ENV_FAVICONS[environment as keyof typeof ENV_FAVICONS];
|
|
25
24
|
|
|
26
25
|
const config: NextConfig = {
|
|
26
|
+
images: {
|
|
27
|
+
remotePatterns: [
|
|
28
|
+
{
|
|
29
|
+
hostname: "h8dxkfmaphn8o0p3.public.blob.vercel-storage.com",
|
|
30
|
+
pathname: "/docs/**",
|
|
31
|
+
protocol: "https",
|
|
32
|
+
},
|
|
33
|
+
],
|
|
34
|
+
},
|
|
27
35
|
...(inMonorepo ? { transpilePackages: ["@vercel/geistdocs"] } : {}),
|
|
28
36
|
cacheComponents: true,
|
|
29
37
|
partialPrefetching: true,
|
package/template/package.json
CHANGED
|
@@ -12,16 +12,14 @@
|
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
14
|
"@ai-sdk/react": "^3.0.134",
|
|
15
|
-
"@icons-pack/react-simple-icons": "^13.8.0",
|
|
16
15
|
"@orama/tokenizers": "^3.1.16",
|
|
17
16
|
"@streamdown/cjk": "^1.0.1",
|
|
18
17
|
"@streamdown/code": "^1.0.1",
|
|
19
18
|
"@vercel/agent-readability": "^0.7.0",
|
|
20
19
|
"@vercel/analytics": "^1.6.1",
|
|
21
|
-
"@vercel/geistdocs": "
|
|
20
|
+
"@vercel/geistdocs": "2.0.1",
|
|
22
21
|
"@vercel/speed-insights": "^1.3.1",
|
|
23
22
|
"ai": "^6.0.132",
|
|
24
|
-
"class-variance-authority": "^0.7.1",
|
|
25
23
|
"clsx": "^2.1.1",
|
|
26
24
|
"cmdk": "^1.1.1",
|
|
27
25
|
"dexie": "^4.2.1",
|
|
@@ -30,24 +28,20 @@
|
|
|
30
28
|
"fumadocs-core": "16.2.2",
|
|
31
29
|
"fumadocs-mdx": "14.0.4",
|
|
32
30
|
"fumadocs-ui": "16.2.2",
|
|
33
|
-
"geist": "
|
|
31
|
+
"geist": "1.7.1",
|
|
34
32
|
"jotai": "^2.15.2",
|
|
35
|
-
"lucide-react": "^0.555.0",
|
|
36
33
|
"mermaid": "^11.12.2",
|
|
37
34
|
"motion": "^12.23.25",
|
|
38
35
|
"nanoid": "^5.1.6",
|
|
39
36
|
"next": "16.3.3",
|
|
40
37
|
"next-themes": "^0.4.6",
|
|
41
|
-
"radix-ui": "1.6.4",
|
|
42
38
|
"react": "^19.2.3",
|
|
43
39
|
"react-dom": "^19.2.3",
|
|
44
40
|
"react-player": "^3.4.0",
|
|
45
41
|
"shiki": "3.19.0",
|
|
46
|
-
"sonner": "^2.0.7",
|
|
47
42
|
"streamdown": "^2.1.0",
|
|
48
43
|
"tailwind-merge": "^3.4.0",
|
|
49
44
|
"use-stick-to-bottom": "^1.1.1",
|
|
50
|
-
"vaul": "^1.1.2",
|
|
51
45
|
"zod": "^4.1.13"
|
|
52
46
|
},
|
|
53
47
|
"devDependencies": {
|